TdxCustomDashboardControl.ExportToCSV(string) Method

Exports dashboard content to a file in the comma-separated values (CSV) format.

Declaration

procedure ExportToCSV(const AFileName: string); overload;

Parameters

Name	Type	Description
AFileName	string	An absolute or relative path to the target file.

Remarks

Call the ExportToCSV procedure to export dashboard content to a file in the CSV format.

In this topic…

• End-User Functionality
  • Export to Excel
• Code Example: Export Dashboard Content to CSV File
• Related Compiled Demo
• Other Export Methods
  • Export to File
  • Export to Stream

End-User Functionality

A user can click an Export To button within the TdxDashboardControl component or the Dashboard Viewer dialog:

Export To Excel

A click on the Excel menu item displays the Export To Excel dialog designed to select the required format and associated export settings:

Code Example: Export Dashboard Content to CSV File

The following code example exports content of a configured TdxDashboardControl component to a file in the CSV format:

Delphi

uses
  dxDashboard.Control,  // Declares the TdxDashboardControl component
  dxShellDialogs;       // Declares the TdxSaveFileDialog component
// ...

procedure TMyForm.cxButtonExportToCSVClick(Sender: TObject);
begin
  if not dxSaveFileDialog1.Execute(Handle) then Exit; // Displays the "Save File" dialog
  dxDashboardControl1.ExportToCSV(dxSaveFileDialog1.FileName);  // Saves the dashboard control to a file
end;

C++

#include "dxDashboard.Control.hpp"  // Declares the TdxDashboardControl component
#include "dxShellDialogs.hpp"       // Declares the TdxSaveFileDialog component

// Add the following linker directives to the corresponding CPP source file:
#pragma link "dxDashboard.Control"  // Required to use dxDashboard.Control.hpp declarations
#pragma link "dxShellDialogs"       // Required to use dxShellDialogs.hpp declarations
// ...

void __fastcall TMyForm::cxButtonExportToCSVClick(TObject *Sender)
{
  if(!dxSaveFileDialog1->Execute(Handle)) { return; }  // Displays the "Save File" dialog
  dxDashboardControl1->ExportToCSV(dxSaveFileDialog1->FileName);  // Saves dashboard content to a file
}

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.

Download: Compiled VCL Demos

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\

Other Export Methods

Export to File

ExportTo

Exports dashboard content to a stream in any supported format.

ExportToGIF

Exports dashboard content to a file in the Graphics Interchange Format (GIF).

ExportToJPG

Exports dashboard content to a file in the Joint Photographic Experts Group (JPEG/JPG) format.

ExportToPDF

Exports dashboard content to a file in the Portable Document Format (PDF).

ExportToPNG

Exports dashboard content to a file in the Portable Network Graphics (PNG) format.

ExportToSVG

Exports dashboard content to a file in the Scalable Vector Graphics (SVG) format.

ExportToXLS

Exports dashboard content to a file in the Microsoft Excel® binary format (XLS).

ExportToXLSX

Exports dashboard content to a file in the Office OpenXML Spreadsheet Format (XLSX).

Export to Stream

ExportTo

Exports dashboard content to a stream in any supported format.

ExportToCSV

Exports dashboard content to a stream in the comma-separated values (CSV) format.

ExportToGIF

Exports dashboard content to a stream in the Graphics Interchange Format (GIF).

ExportToJPG

Exports dashboard content to a stream in the Joint Photographic Experts Group (JPEG/JPG) format.

ExportToPDF

Exports dashboard content to a stream in the Portable Document Format (PDF).

ExportToPNG

Exports dashboard content to a stream in the Portable Network Graphics (PNG) format.

ExportToSVG

Exports dashboard content to a stream in the Scalable Vector Graphics (SVG) format.

ExportToXLS

Exports dashboard content to a stream in the Microsoft Excel® binary format (XLS).

ExportToXLSX

Exports dashboard content to a stream in the Office OpenXML Spreadsheet Format (XLSX).