DashboardPdfExportOptions.ScaleMode Property

OBSOLETE

The DashboardPdfExportOptions.ScaleMode property is obsolete now. Use the DocumentScaleMode and DashboardAutomaticPageLayout properties instead.

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

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v23.2.Core.dll

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

[Browsable(false)]
[Obsolete("The DashboardPdfExportOptions.ScaleMode property is obsolete now. Use the DocumentScaleMode and DashboardAutomaticPageLayout properties instead.")]
public DashboardExportScaleMode ScaleMode { get; set; }

VB.NET

<Obsolete("The DashboardPdfExportOptions.ScaleMode property is obsolete now. Use the DocumentScaleMode and DashboardAutomaticPageLayout properties instead.")>
<Browsable(False)>
Public Property ScaleMode As DashboardExportScaleMode

Property Value

Type	Description
DashboardExportScaleMode	A DashboardExportScaleMode 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.
AutoFitToPageWidth	The size of the dashboard/dashboard item is changed according to the width of the exported page.
AutoFitWithinOnePage	The size of the dashboard/dashboard item is changed to fit its content on a single page.

Property Paths

You can access this nested property as listed below:

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

Remarks

To change the size of the dashboard or split it into several pages, specify the ScaleMode property. Then specify the following export options depending on the selected mode.

Scale Mode	Related Property	Description
DashboardExportScaleMode.AutoFitToPageWidth	DashboardPdfExportOptions.AutoFitPageCount	Splits the dashboard into multiple pages and aligns it.
DashboardExportScaleMode.UseScaleFactor	DashboardPdfExportOptions.ScaleFactor	Scales the dashboard.
DashboardExportScaleMode.AutoFitWithinOnePage	n/a	Changes the dashboard size to fit its content on a single page.
DashboardExportScaleMode.None	n/a	The dashboard size is fixed, and other dashboard scaling settings are not in effect.