TdxCustomReportControl Class

The base class for the VCL Report control.

Declaration

TdxCustomReportControl = class(
    TdxWebBrowser
)

Remarks

TdxReportControl is a visual component designed to allow users to work with reports on any form.

VCL Reports: The TdxReportControl Component in the "Report Designer/Viewer" Demo

In this topic…

Prerequisites & Deployment
Bind to Data
- Data Connection Components
Main API Members

Prerequisites & Deployment

Note

ExpressReports will require the purchase of our VCL Subscription + OR an active VCL Subscription (regular) with any active .NET subscription that includes DevExpress Reports for ASP.NET/JavaScript (these subscriptions include: Reporting, ASP.NET & Blazor (includes DevExtreme), DXperience, or Universal).
ExpressDashboards will also require the purchase of our VCL Subscription + OR an active VCL Subscription (regular) with an active Universal Subscription that includes DevExpress Business Intelligence (BI) Dashboard.

Ensure that your development environment meets ExpressDashboards and ExpressReports prerequisites:

Microsoft Windows 10 or newer.
Embarcadero RAD Studio IDE 12.3 or newer (Community Edition IDEs are not supported).
DevExpress VCL v26.1.x.
The EdgeView2 SDK package installed from the GetIt package manager.

Tip

Refer to the following topic for detailed information: VCL Reports/Dashboards App Deployment.

Bind to Data

TdxReportControl can populate placeholder fields in a template from different data sources stored in memory or a database. The TdxBackendDataConnectionManager component allows you to manage data connection components designed to work with different data sources.

Tip

You can create data connection components directly in code, without TdxBackendDataConnectionManager.

Refer to the data connection class descriptions for detailed information and code examples.

Data Connection Components

TdxBackendDataSetJSONConnection

A component designed to work with data in one or multiple VCL-compatible datasets (TDataSet descendants).

Use the TdxBackendDataSetJSONConnection component if you need to use TdxDashboardControl/TdxDashboard and TdxReport components together with VCL-compatible data sources.

Refer to the following help topic for step-by-step instructions on using the TdxBackendDataSetJSONConnection component in your project:

VCL Reports/Dashboards: How to Use Data Source and Data Set Components

TdxBackendInMemoryJSONConnection

A component designed for interaction with local (in-memory) or remote JSON data accessible through a Web API service endpoint.

Refer to the following help topic for step-by-step instructions on using the TdxBackendInMemoryJSONConnection component as a data source for TdxDashboard/TdxDashboardControl and TdxReport:

VCL Reports/Dashboards: How to Use Memory-Based or Remote API Data Sources

TdxBackendDatabaseSQLConnection

A DevExpress XPO-based component designed to fetch data from the following relational databases:

Tip

This component is based on the DevExpress XPO ORM engine (powered by ADO.NET).

TdxBackendDatabaseSQLConnection has built-in support for Microsoft SQL/Azure SQL and SQLite engines (you can use them without additional dependencies and extra configuration).

Refer to the following topic for a complete list of supported database engines and corresponding connection string examples:

VCL Reports/Dashboards: Supported Database Engines

Main API Members

The list below outlines key members of the TdxCustomReportControl class. These members allow you to configure templates, generate reports, and export content in different target formats.

Report Content & Layout

Clear: Clears the current report name, layout, and parameters.
EnableCustomSql: Specifies if custom SQL queries are enabled at the TdxReportControl level.

Important
Enable custom SQL queries only if you ensure that you follow best practices and implement user read/write privileges at the database level using the tools available for your relational database management system.
Language: Allows you to switch between available UI and report template localizations. Refer to the following topic for information on localization techniques: VCL Reports Localization.
Layout: Provides access to the report REPX template (as individual XML strings).
OnLayoutChanged: Allows you to respond to any report layout changes.
OnResolveConnection: Allows you to map different data connection components to the same data source name referenced within the current report layout definition.
Parameters: Provides access to the read-only collection of report parameters.

Note
The Parameters collection is automatically populated and updated from the current report template definition.

You can only access and modify individual report parameters using the Parameters.Items property and other API members accessible through the Parameters property.
ReloadData: Reloads data from all underlying data sources on demand and updates report placeholder content.
ReportName: Specifies the report name.

End-User Interaction

ExportFormats: Specifies export formats available to users in the UI (including the modal Report Viewer dialog).
OnExport: Allows you to execute custom code in response to preview file save operations to prevent users from exporting report content.
OnDesignerFormShow | OnViewerFormShow: Allow you to customize Report Designer and Report Viewer dialog form settings (position, dimensions, caption, etc.).
OnPrintPreview: Allows you to respond to print preview operations and obtain preview content as a PDF document.
ShowDesigner | ShowViewer: Display modal Report Designer and Report Viewer dialogs. Global skin and palette settings (defined using the Project Settings dialog or a TdxSkinController component) affect these dialogs.

Report Import & Export

ExportTo: Exports the current report to a file or stream in any supported format (except for PRNX).
ExportToCSV | ExportToDOCX | ExportToHTML | ExportToMHT | ExportToPDF | ExportToRTF | ExportToText | ExportToXLS | ExportToXLSX: Export the current report to a file or stream in corresponding formats.
ExportToImage: Exports the current report to a file or stream as an image (PNG is the default image export format).

Tip
The current image format is defined in Export Options available in the TdxReportControl UI and the modal Report Designer dialog.
GetExportResultFileName: Returns the full report file name for export operations.
LoadDocument: Imports a previously generated report document from a file or stream in the XML-based report archive (REPX) format.
SaveDocument: Exports the current report to a file or stream in the XML-based report archive (REPX) format.