DashboardImageExportOptions Class

Contains options related to exporting a dashboard/dashboard item to an image.

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v24.1.Core.dll

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

public class DashboardImageExportOptions :
    IDashboardImageExportOptions,
    IDashboardExportOptions

VB.NET

Public Class DashboardImageExportOptions
    Implements IDashboardImageExportOptions,
               IDashboardExportOptions

Related API Members

The following members return DashboardImageExportOptions objects:

• ASPxDashboard.ImageExportOptions
• BeforeExportDocumentEventArgs.ImageExportOptions
• BeforeExportDocumentWebEventArgs.ImageExportOptions
• CustomExportBaseEventArgs.ImageExportOptions
• CustomExportBaseWebEventArgs.ImageExportOptions
• DashboardControl.ImageExportOptions
• DashboardDesigner.ImageExportOptions
• DashboardExtensionSettings.ImageExportOptions
• DashboardViewer.ImageExportOptions
• IDashboardControl.ImageExportOptions

Remarks

The following properties allow you to access default image-specific export options for different controls.

• ASPxDashboard.ImageExportOptions / DashboardExtensionSettings.ImageExportOptions
• DashboardDesigner.ImageExportOptions
• DashboardViewer.ImageExportOptions
• DashboardControl.ImageExportOptions

Moreover, you can specify image options when exporting a dashboard/dashboard item using the following methods.

• WebDashboardExporter.ExportToImage / WebDashboardExporter.ExportDashboardItemToImage
• DashboardDesigner.ExportToImage / DashboardDesigner.ExportDashboardItemToImage
• DashboardViewer.ExportToImage / DashboardViewer.ExportDashboardItemToImage
• DashboardControl.ExportToImage / DashboardControl.ExportDashboardItemToImage

Note

To export a dashboard/dashboard item on the web using an API, use the ExportToImage and ExportDashboardItemToImage methods exposed by the ASPxClientDashboard class.

Example

The following code snippet shows how to export the Chart dashboard item displayed within the DashboardDesigner using the DashboardDesigner.ExportDashboardItemToImage method with specific image-export options specified.

C#

using DevExpress.DashboardCommon;
// ...
            dashboardDesigner1.ExportDashboardItemToImage("chartDashboardItem1", @"c:\temp\ExportedImage.jpg", new DashboardImageExportOptions() {
                    Format = DashboardExportImageFormat.Jpeg,
                    ScaleFactor = 1.5f
                }
            );

VB.NET

Imports DevExpress.DashboardCommon
' ...
            dashboardDesigner1.ExportDashboardItemToImage("chartDashboardItem1", "c:\temp\ExportedImage.jpg", New DashboardImageExportOptions() With { _
                Key .Format = DashboardExportImageFormat.Jpeg, _
                Key .ScaleFactor = 1.5F _
            })

Inheritance

Object

DashboardImageExportOptions