Skip to main content
All docs
V25.2
  • TdxDashboardUIExportFormat Enum

    Enumerates dashboard format groups for export operations available in the UI.

    Declaration

    TdxDashboardUIExportFormat = (
        PDF,
        Excel,
        Image
    );

    Members

    Name Description
    PDF

    Portable Document Format (PDF).

    Excel

    Microsoft Excel® Spreadsheet Formats (XLSX, XLS, and CSV).

    Image

    All supported image formats (GIF, JPG, PNG, and SVG).

    Remarks

    The Dashboard Viewer dialog allows users to export the current dashboard or an individual dashboard item in any supported image or document format.

    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 Dashboard Viewer dialog:

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

    “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

    Available Options

    You can use the TdxCustomDashboardControl.ExportFormats property to specify export format groups available to users.

    Note

    TdxDashboardUIExportFormat is a scoped enumeration type. Use the type name together with a scope resolution token (. in Delphi or :: in C++Builder) followed by an enumeration value to refer to this value. For example, use TdxDashboardUIExportFormat.Image (in Delphi) or TdxDashboardUIExportFormat::Image (in C++Builder) to refer to the Image value in code.

    Direct TdxDashboardUIExportFormat Type References

    The following public APIs reference the TdxDashboardUIExportFormat type:

    AllDashboardUIExportFormats
    A set of flags that correspond to all export format groups available to users in the Dashboard Viewer dialog UI.
    TdxDashboardUIExportFormats
    A set of flags that correspond to export format groups available to users in the Dashboard Viewer dialog UI.
    See Also