Skip to main content
BuyLog In
VCL
Search in…
Docs > VCL Controls > ExpressDashboards Suite > API Reference > dxDashboard > TdxDashboard > Members
All docs
V26.1
    • VCL Controls
    What's New
    Installation
    Express Cross Platform Library
    ExpressQuantumGrid Suite
    ExpressEditors Library
    ExpressBars Suite
    ExpressCharts Suite
    ExpressDashboards Suite
    Getting Started
    Export Functionality
    GitHub Examples
    API Reference
    dxDashboard
    TdxDashboard
    Members
    Properties
    Methods
    Events
    TdxDashboardExportEvent
    TdxDashboardNotifyEvent
    TdxDashboardResolveConnectionEvent
    dxDashboard.Control
    dxDashboard.Parameters
    ExpressReports Suite
    ExpressRichEditControl Suite
    ExpressSkins Library
    ExpressScheduler Suite
    ExpressSpreadSheet Suite
    ExpressQuantumTreeList Suite
    ExpressPDFViewer Suite
    ExpressPrinting System
    ExpressLayoutControl Suite
    ExpressNavBar Suite
    ExpressPivotGrid Suite
    ExpressVerticalGrid Suite
    ExpressDocking Library
    ExpressMemData
    ExpressDataController
    ExpressSpellChecker Suite
    ExpressMapControl Suite
    ExpressGanttControl Suite
    ExpressGaugeControl Suite
    ExpressTileControl Suite
    ExpressFlowChart Suite
    ExpressFlowChart Editor
    ExpressOrgChart Suite
    ExpressPageControl Suite
    ExpressWizardControl Suite

    TdxDashboard Members

    A non-visual VCL Dashboard container designed to generate and export dashboard content.

    Properties

    Name Description
    EnableCustomSql Specifies if custom SQL queries are enabled for the loaded layout definition.
    ExportFormats Specifies export formats available to users.
    Language Specifies the required language (for dashboard content localization).
    Layout Provides access to the dashboard layout definition (in the XML format).
    Name Specifies the dashboard name (for template/layout management and content export).
    Parameters Provides access to the collection of dashboard parameters
    State Provides access to the dashboard state (in the JSON format).

    Methods

    Name Description
    Assign(TPersistent) Inherited from TPersistent.
    AssignTo(TPersistent) Inherited from TPersistent.
    Clear Clears the TdxDashboard container.
    Equals(TObject) Inherited from TObject.
    ExportTo(TdxDashboardExportFormat,TStream,string) Exports dashboard content to a stream in any supported format. Returns the file name that corresponds to the dashboard layout name and the target export format.
    ExportTo(TdxDashboardExportFormat,TStream) Exports dashboard content to a stream in any supported format.
    ExportTo(TdxDashboardExportFormat,string) Exports dashboard content to a stream in any supported format.
    ExportToCSV(TStream) Exports dashboard content to a stream in the comma-separated values (CSV) format.
    ExportToCSV(string) Exports dashboard content to a file in the comma-separated values (CSV) format.
    ExportToGIF(TStream) Exports dashboard content to a stream in the Graphics Interchange (GIF) format.
    ExportToGIF(string) Exports dashboard content to a file in the Graphics Interchange (GIF) format.
    ExportToJPG(TStream) Exports dashboard content to a stream in the Joint Photographic Experts Group (JPG/JPEG) format.
    ExportToJPG(string) Exports dashboard content to a file in the Joint Photographic Experts Group (JPG/JPEG) format.
    ExportToPDF(TStream) Exports dashboard content to a stream in the Portable Document (PDF) format.
    ExportToPDF(string) Exports dashboard content to a file in the Portable Document (PDF) format.
    ExportToPNG(TStream) Exports dashboard content to a stream in the Portable Network Graphics (PNG) format.
    ExportToPNG(string) Exports dashboard content to a file in the Portable Network Graphics (PNG) format.
    ExportToSVG(TStream) Exports dashboard content to a stream in the Scalable Vector Graphics (SVG) format.
    ExportToSVG(string) Exports dashboard content to a file in the Scalable Vector Graphics (SVG) format.
    ExportToXLS(TStream) Exports dashboard content to a stream in the Microsoft Excel® binary (XLS) format.
    ExportToXLS(string) Exports dashboard content to a file in the Microsoft Excel® binary (XLS) format.
    ExportToXLSX(TStream) Exports dashboard content to a stream in the Office OpenXML Spreadsheet (XLSX) format.
    ExportToXLSX(string) Exports dashboard content to a file in the Office OpenXML Spreadsheet (XLSX) format.
    GetConnectionNames
    GetHashCode Inherited from TObject.
    GetNamePath Inherited from TPersistent.
    GetOwner Inherited from TPersistent.
    ShowDesigner Displays the Dashboard Designer dialog.
    ShowViewer Displays the Dashboard Viewer dialog.
    ToString Inherited from TObject.

    Events

    Name Description
    OnDesignerFormShow Allows you to customize Dashboard Designer dialog form settings.
    OnExport Allows you to modify the dashboard export target or prevent users from exporting dashboard content.
    OnLayoutChanged Allows you to save dashboard layout changes made in the Dashboard Designer dialog.
    OnResolveConnection Allows you to map different data connection components to the same data source name referenced within the current dashboard layout definition.
    OnStateChanged Allows you to save dashboard/user interaction state changes.
    OnViewerFormShow Allows you to customize Dashboard Designer dialog form settings.
    See Also