DashboardPdfExportOptions.DocumentScaleMode Property

Gets or sets the mode for scaling a dashboard/dashboard item in the exported document.

Namespace: DevExpress.DashboardCommon

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

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

[DefaultValue(DashboardExportDocumentScaleMode.None)]
public DashboardExportDocumentScaleMode DocumentScaleMode { get; set; }

VB.NET

<DefaultValue(DashboardExportDocumentScaleMode.None)>
Public Property DocumentScaleMode As DashboardExportDocumentScaleMode

Property Value

Type	Default	Description
DashboardExportDocumentScaleMode	None	A DashboardExportDocumentScaleMode enumeration value that specifies the mode for scaling a dashboard/dashboard item in the exported document.

Available values:

Name	Description
None	The dashboard / dashboard item on the exported page retains its original size.
UseScaleFactor	The size of the dashboard / dashboard item on the exported page is changed according to the scale factor value.
AutoFitToPagesWidth	The size of the dashboard / dashboard item is changed according to the width of the exported pages.

Property Paths

You can access this nested property as listed below:

Object Type	Path to DocumentScaleMode
BeforeExportDocumentEventArgs	.PdfExportOptions .DocumentScaleMode
CustomExportBaseEventArgs	.PdfExportOptions .DocumentScaleMode
ASPxDashboard	.PdfExportOptions .DocumentScaleMode
BeforeExportDocumentWebEventArgs	.PdfExportOptions .DocumentScaleMode
CustomExportBaseWebEventArgs	.PdfExportOptions .DocumentScaleMode
DashboardExtensionSettings	.PdfExportOptions .DocumentScaleMode
DashboardDesigner	.PdfExportOptions .DocumentScaleMode
DashboardViewer	.PdfExportOptions .DocumentScaleMode
IDashboardControl	.PdfExportOptions .DocumentScaleMode
DashboardControl	.PdfExportOptions .DocumentScaleMode

Remarks

To change the size of the dashboard or split it into several pages, use the DocumentScaleMode property and specify the following export options depending on the selected mode:

Scale Mode	Related Property	Description
DashboardExportDocumentScaleMode.AutoFitToPagesWidth	DashboardPdfExportOptions.AutoFitPageCount	Splits the dashboard into multiple pages and aligns it.
DashboardExportDocumentScaleMode.UseScaleFactor	DashboardPdfExportOptions.ScaleFactor	Scales the dashboard.
DashboardExportDocumentScaleMode.None	n/a	The dashboard size is fixed, and other dashboard scaling settings are not in effect.