DashboardDesigner.ExportDashboardItemToImage(String, String, DashboardImageExportOptions) Method

Exports the dashboard item to the image file using the specified image options.

Namespace: DevExpress.DashboardWin

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

NuGet Package: DevExpress.Win.Dashboard

Declaration

C#

public void ExportDashboardItemToImage(
    string dashboardItemName,
    string filePath,
    DashboardImageExportOptions options
)

VB.NET

Public Sub ExportDashboardItemToImage(
    dashboardItemName As String,
    filePath As String,
    options As DashboardImageExportOptions
)

Parameters

Name	Type	Description
dashboardItemName	String	A String that is the component name of the dashboard item to be exported.
filePath	String	A String that specifies the path to the image file.
options	DashboardImageExportOptions	A DashboardImageExportOptions object that specifies the image export options to be applied when the dashboard item is exported.

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 _
            })

Implements

ExportDashboardItemToImage(String, String, DashboardImageExportOptions)