DashboardImageExportOptions.Format Property

Gets or sets an image format in which the dashboard/dashboard item is exported.

Namespace: DevExpress.DashboardCommon

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

Declaration

C#

[DefaultValue(DashboardExportImageFormat.Png)]
public DashboardExportImageFormat Format { get; set; }

VB.NET

<DefaultValue(DashboardExportImageFormat.Png)>
Public Property Format As DashboardExportImageFormat

Property Value

Type	Default	Description
DashboardExportImageFormat	Png	A DashboardExportImageFormat object that specifies an image format in which the dashboard/dashboard item is exported.

Available values:

Name	Description
Png	The PNG image format.
Jpeg	The JPG image format.
Gif	The GIF image format.

Property Paths

You can access this nested property as listed below:

Show 15 property paths

Object Type	Path to Format
BeforeExportDocumentEventArgs	.ImageExportOptions.Format
CustomExportBaseEventArgs	.ImageExportOptions.Format
CustomExportEventArgs	.ImageExportOptions.Format
CustomizeExportDocumentEventArgs	.ImageExportOptions.Format
ASPxDashboard	.ImageExportOptions.Format
BeforeExportDocumentWebEventArgs	.ImageExportOptions.Format
CustomExportBaseWebEventArgs	.ImageExportOptions.Format
CustomExportWebEventArgs	.ImageExportOptions.Format
CustomizeExportDocumentWebEventArgs	.ImageExportOptions.Format
DashboardExtensionSettings	.ImageExportOptions.Format
MVCxDashboard	.ImageExportOptions.Format
DashboardDesigner	.ImageExportOptions.Format
DashboardViewer	.ImageExportOptions.Format
IDashboardControl	.ImageExportOptions.Format
DashboardControl	.ImageExportOptions.Format

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Format property.

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#L54

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