ContextQMD
Back to Devexpress

DesignAnalyzerOptions Class

xtrareports-devexpress-dot-xtrareports-dot-configuration-4e9a4af6.md

latest7.1 KB
Original Source

DesignAnalyzerOptions Class

Contains methods that allow you to configure the Report Design Analyzer.

Namespace : DevExpress.XtraReports.Configuration

Assembly : DevExpress.XtraReports.v25.2.dll

NuGet Package : DevExpress.Reporting.Core

Declaration

csharp
public class DesignAnalyzerOptions
vb
Public Class DesignAnalyzerOptions

The following members return DesignAnalyzerOptions objects:

Remarks

The Report Design Analyzer shows errors, warnings, and information messages that help you and your end users to detect and fix issues in a report.

Use the DesignAnalyzerOptions class to configure the Report Design Analyzer. For example, you can enable or disable the following items:

You can use the DesignAnalyzerOptions class for all supported Desktop (WinForms and WPF) and Web platforms. To change the default settings, access the class instance in a method called at application startup and specify instance properties:

csharp
using DevExpress.XtraReports.Configuration;
//...

Settings.Default.DesignAnalyzerOptions.ShowErrors = false;
vb
Imports DevExpress.XtraReports.Configuration
'...

Settings.Default.DesignAnalyzerOptions.ShowErrors = False

In reporting applications with an ASP.NET Core backend, change the default settings as follows:

csharp
var app = builder.Build();

app.UseReporting(x => {
    x.DesignAnalyzerOptions.ShowErrors = false;
});

app.Run();

Based on their source, report errors are divided into four groups:

  • Report layout errors – occur, for example, when report controls overlap each other or extend beyond the report’s printable area.
  • Report creation errors – occur while the report document is created. For instance, it might include notifications about invalid property values or unreachable sources of content.
  • Report export errors – happen while the report document is exported to PDF, XLSX, and other formats.
  • Report script errors – for example, errors in script syntax.

You can use the following properties to disable error messages that belong to a particular error source:

Enable/Disable Messages of a Particular Error Type

Use the following properties to disable messages of the “Error”, “Warning”, or “Information” type:

You can also suppress error codes to disable messages associated with them. Refer to the SuppressedErrorCodes property description for instructions.

Enable Accessibility Validation

Use the DesignAnalyzerOptions.EnableAccessibilityValidation property to display accessibility-related issues in the Report Design Analyzer.

csharp
using DevExpress.XtraReports.Configuration;
//...

Settings.Default.DesignAnalyzerOptions.EnableAccessibilityValidation = true;
vb
Imports DevExpress.XtraReports.Configuration
'...

Settings.Default.DesignAnalyzerOptions.EnableAccessibilityValidation = true

Use filters by type and source to navigate long issue lists:

  • Like other report design issues, accessibility issues are divided into errors, warnings, and messages. If you deselect the Warnings button, all accessibility warnings will be hidden.
  • The source filter allows you to select report controls where issues originate.

An error code link navigates users to a DevExpress Reporting documentation page that describes the error and how to fix it.

Use the EnableErrorCodeLinks property to enable error code links.

Enable/Disable Error Notification Popup in Preview

A report document may contain errors that occur during its creation. The Report Design Analyzer shows them in a notification popup when you preview the report:

You can enable/disable this popup. See the description of the following property for details: ShowNotificationPopup.

Inheritance

Object DesignAnalyzerOptions

See Also

DesignAnalyzerOptions Members

DevExpress.XtraReports.Configuration Namespace