TdxCustomDashboardControl.ExportTo(TdxDashboardExportFormat,TStream,string) Method
Exports dashboard content to a stream in any supported format.
Declaration
procedure ExportTo(AFormat: TdxDashboardExportFormat; AStream: TStream; out AFileName: string); overload;Parameters
| Name | Type | Description |
|---|---|---|
| AFormat | TdxDashboardExportFormat | The target export format. Refer to the following section for details: Available Export Formats. |
| AStream | TStream | The target stream. |
| AFileName | string | Returns a string that consists of the DashboardName property value and the file name extension associated with the target export format. |
Remarks
Call the ExportTo procedure to export dashboard content to a stream in any supported format.
The ExportTimeout property allows you to set a timeout interval (in milliseconds) for export operations. If the specified export timeout is reached, an exception is thrown.
Tip
The AFileName parameter is useful if you need to save target stream (AStream) content to a file after the export operation.
Available Export Formats
| AFormat Parameter Value | Content Format | Format-Specific Export Method |
|---|---|---|
| TdxDashboardExportFormat.CSV | Comma-Separated Values | ExportToCSV |
| TdxDashboardExportFormat.GIF | Graphics Interchange Format (GIF) | ExportToGIF |
| TdxDashboardExportFormat.JPG | Joint Photographic Experts Group (JPEG) | ExportToJPG |
| TdxDashboardExportFormat.PDF | Portable Document Format (PDF) | ExportToPDF |
| TdxDashboardExportFormat.PNG | Portable Network Graphics (PNG) | ExportToPNG |
| TdxDashboardExportFormat.SVG | Scalable Vector Graphics (SVG) | ExportToSVG |
| TdxDashboardExportFormat.XLS | Microsoft Excel® Binary Format (XLS) | ExportToXLS |
| TdxDashboardExportFormat.XLSX | Office OpenXML Spreadsheet Format (XLSX) | ExportToXLSX |
Related Compiled Demo
To see the dashboard export functionality in action, run the BI Dashboards Designer/Viewer demo in the VCL Demo Center installed with compiled DevExpress VCL demos. Select any demo in the sidebar on the left, click the Export button, and use any export option listed in the menu.
Tip
You can find full source code for the installed compiled Report demo in the following folder:
%PUBLIC%\Documents\DevExpress VCL Demos\MegaDemos\Product Demos\ExpressDashboards\