Skip to main content

DashboardPrintPreviewOptions.DocumentScaleMode Property

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

Namespace: DevExpress.DashboardCommon

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

NuGet Package: DevExpress.Dashboard.Core

Declaration

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

Property Value

Type Default Description
DashboardExportDocumentScaleMode None

A DashboardExportDocumentScaleMode enumeration value that specifies the mode for scaling a dashboard/dashboard item in the printed 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
.PrintPreviewOptions .DocumentScaleMode
CustomExportBaseEventArgs
.PrintPreviewOptions .DocumentScaleMode
DashboardDesigner
.PrintPreviewOptions .DocumentScaleMode
DashboardViewer
.PrintPreviewOptions .DocumentScaleMode
IDashboardControl
.PrintPreviewOptions .DocumentScaleMode
DashboardControl
.PrintPreviewOptions .DocumentScaleMode

Remarks

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

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