TdxCustomDashboardControl.ExportToXLS(TStream) Method

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

Declaration

procedure ExportToXLS(AStream: TStream); overload;

Parameters

Name	Type	Description
AStream	TStream	The target stream.

Remarks

Call the ExportToXLS procedure to export dashboard content to a stream in the XLS format.

In this topic…

• End-User Functionality
  • Export to Excel
• Code Example: Export Dashboard Content to XLS 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 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 XLS File

The following code example exports content of a configured TdxDashboardControl component to a file in the Microsoft Excel® binary (XLS) format using an intermediary TMemoryStream object:

Delphi

uses
  dxDashboard.Control,  // Declares the TdxDashboardControl component
  dxSplashForms,     // Declares the TdxSplashFormManager class and related types
  dxShellDialogs;    // Declares the TdxSaveFileDialog component
// ...

procedure TMyForm.cxButtonExportToXLSClick(Sender: TObject);
var
  AStream: TMemoryStream;
begin
  if not dxSaveFileDialog1.Execute(Handle) then Exit;  // Displays the "Save File" dialog
  AStream := TMemoryStream.Create;       // Creates a stream as an intermediary container
  // Displays a Wait Form before the export operation
  TdxSplashFormManager.WaitForm.Show(dxDashboardControl1.Parent);
  try
    dxDashboardControl1.ExportToXLS(AStream);   // Exports content to a stream in the XLS format
    AStream.SaveToFile(dxSaveFileDialog1.FileName);    // Saves XLS stream content to a file
  finally
    AStream.Free;                        // Releases the intermediary memory stream
    TdxSplashFormManager.WaitForm.Hide;  // Hides the Wait Form once the operation is complete
  end;
end;

C++

#include "dxDashboard.Control.hpp"  // Declares the TdxDashboardControl component
#include "dxSplashForms.hpp"     // Declares the TdxSplashFormManager class and related types
#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 "dxSplashForms"     // Required to use dxSplashForms.hpp declarations
#pragma link "dxShellDialogs"    // Required to use dxShellDialogs.hpp declarations
// ...

void __fastcall TMyForm::cxButtonExportToXLSClick(TObject *Sender)
{
  if(!dxSaveFileDialog1->Execute(Handle)) { return; }  // Displays the "Save File" dialog
  TMemoryStream *AStream = new TMemoryStream();  // Creates a stream as an intermediary container
  // Displays a Wait Form before the export operation
  TdxSplashFormManager::WaitForm()->Show(dxDashboardControl1->Parent);
  try
  {
    dxDashboardControl1->ExportToXLS(AStream);  // Exports content to a stream in the XLS format
    AStream->SaveToFile(dxSaveFileDialog1->FileName);  // Saves XLS stream content to a file
  }
  __finally
  {
    delete AStream;                              // Releases the intermediary memory stream
    TdxSplashFormManager::WaitForm()->Hide();    // Hides the Wait Form once the operation is complete
  }
}

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.

ExportToCSV

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

ExportToGIF

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

ExportToJPG

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

ExportToPDF

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

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 (XLS) format.

ExportToXLSX

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

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 (GIF) format.

ExportToJPG

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

ExportToPDF

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

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.

ExportToXLSX

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