Skip to main content
BuyLog In
VCL
Search in…
Docs > VCL Controls > ExpressDashboards Suite > API Reference > dxDashboard.Control > TdxCustomDashboardControl > Properties > ExportFormats
All docs
V25.2
    • VCL Controls
    What's New
    Installation
    Express Cross Platform Library
    ExpressQuantumGrid Suite
    ExpressEditors Library
    ExpressBars Suite
    ExpressCharts Suite
    ExpressDashboards Suite
    Getting Started
    GitHub Examples
    API Reference
    dxDashboard
    dxDashboard.Control
    TdxCustomDashboardControl
    Members
    Constructors
    Properties
    DashboardName
    EnableCustomSql
    ExportFormats
    Language
    Layout
    Parameters
    State
    Methods
    Events
    TdxDashboardControl
    TdxDashboardControlExportEvent
    TdxDashboardControlNotifyEvent
    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

    TdxCustomDashboardControl.ExportFormats Property

    Specifies export formats available to users.

    Declaration

    property ExportFormats: TdxDashboardUIExportFormats read; write; default AllDashboardUIExportFormats;

    Property Value

    Type Default Description
    TdxDashboardUIExportFormats AllDashboardUIExportFormats

    The set of flags that correspond to individual supported export formats.

    Remarks

    Users can export export the current dashboard or an individual dashboard item to a file in any supported image or document format.

    In this topic…

    “Export To” Buttons

    Users can click the Export To button for an individual dashboard item or an entire dashboard to export corresponding content to a document or image file:

    VCL Dashboards: "Export To" Buttons in the Dashboard Viewer Dialog

    Export To Menu and Format Groups

    The TdxDashboardUIExportFormat type enumerates export format groups displayed when a user clicks an Export To button within the TdxDashboardControl or the Dashboard Viewer dialog:

    VCL Dashboards: An "Export Formats" Menu Example in the Dashboard Viewer Dialog

    Tip

    Refer to the following section for information on corresponding ExportFormats property values: Available Options.

    “Export To” Dialog

    A click on a menu item displays the corresponding modal dialog designed to select the required format and associated export settings:

    VCL Dashboards: Image Export Settings

    A click on the Export button in the Export To dialog raises the OnExport event.

    You can handle this event to execute custom code in response to a dashboard content download operation, modify the download target, replace the built-in Save As dialog, or prevent the operation depending on specific conditions in your application.

    Available Options

    The ExportFormats property can contain TdxDashboardUIExportFormat flags in any combination. Each of the following flags corresponds to an export format group and an Export To menu item available to users in the TdxDashboardControl component and the Dashboard Viewer dialog:

    TdxDashboardUIExportFormat.Excel
    The Microsoft Excel® group includes Office Open XML (XLSX), Microsoft Excel® binary (XLS), and comma-separated values (CSV) formats. The Export To Excel dialog allows users to switch between supported spreadsheet formats.
    TdxDashboardUIExportFormat.Image
    The Image group includes the following formats: GIF, JPG, PNG, and SVG. The Export To Image dialog allows users to switch between supported image formats.
    TdxDashboardUIExportFormat.PDF
    This option displays the Export To PDF dialog that allows users to configure document page settings and export dashboard content as a PDF file.

    Dashboard 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 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).

    Default Value

    The ExportFormats property’s default value is the AllDashboardUIExportFormats global constant.

    See Also