WebDashboardExporter.ExportToImage(String, Stream, Size, DashboardState, DashboardImageExportOptions) Method

Exports a dashboard to the specified stream in Image format.

Namespace: DevExpress.DashboardWeb

Assembly: DevExpress.Dashboard.v23.1.Web.dll

NuGet Package: DevExpress.Web.Dashboard.Common

Declaration

C#

public void ExportToImage(
    string dashboardId,
    Stream stream,
    Size dashboardSize,
    DashboardState state,
    DashboardImageExportOptions options
)

VB.NET

Public Sub ExportToImage(
    dashboardId As String,
    stream As Stream,
    dashboardSize As Size,
    state As DashboardState,
    options As DashboardImageExportOptions
)

Parameters

Name	Type	Description
dashboardId	String	A String that specifies the identifier of a dashboard to be exported.
stream	Stream	A Stream object to which the created image file should be sent.
dashboardSize	Size	A Size object that specifies the dashboard size.
state	DashboardState	A DashboardState object that specifies the dashboard state to be applied to the resulting document.
options	DashboardImageExportOptions	A DashboardImageExportOptions object containing Image-specific options.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ExportToImage(String, Stream, Size, DashboardState, DashboardImageExportOptions) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

aspxdashboard-how-to-switch-dashboards-by-clicking-thumbnails-displayed-in-image-slider-t526185/CS/WebApplication18/Default.aspx.cs#L53

using (FileStream fs = new FileStream(fullPath, FileMode.OpenOrCreate, FileAccess.Write))
    exporter.ExportToImage(dashboards[i].ID, fs, new Size(1000, 1000), null, new DashboardImageExportOptions() {
        Format = DevExpress.DashboardCommon.DashboardExportImageFormat.Png

VB.NET

aspxdashboard-how-to-switch-dashboards-by-clicking-thumbnails-displayed-in-image-slider-t526185/VB/WebApplication18/Default.aspx.vb#L55

Using fs As New FileStream(fullPath, FileMode.OpenOrCreate, FileAccess.Write)
    exporter.ExportToImage(dashboards(i).ID, fs, New Size(1000, 1000), Nothing, New DashboardImageExportOptions() With {.Format = DevExpress.DashboardCommon.DashboardExportImageFormat.Png})
End Using