DashboardPdfExportOptions.DashboardStatePosition Property

Gets or sets a position of the dashboard state (such as master filter or current parameter values) in the exported document.

Namespace: DevExpress.DashboardCommon

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

Declaration

C#

[DefaultValue(DashboardStateExportPosition.Below)]
public DashboardStateExportPosition DashboardStatePosition { get; set; }

VB.NET

<DefaultValue(DashboardStateExportPosition.Below)>
Public Property DashboardStatePosition As DashboardStateExportPosition

Property Value

Type	Default	Description
DashboardStateExportPosition	Below	A DashboardStateExportPosition object that specifies a position of the dashboard state in the exported document.

Available values:

Name	Description
Below	The dashboard state is placed below the exported dashboard/dashboard item.
SeparatePage	The dashboard state is placed on a separate page.

Property Paths

You can access this nested property as listed below:

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

Remarks

To add a master state to the exported document, use the DashboardPdfExportOptions.ExportFilters property. To export current parameter values, enable the DashboardPdfExportOptions.ExportParameters flag.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DashboardStatePosition 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#

web-forms-dashboard-implement-server-side-export/CS/ASPxDashboard_ServerExport/Default.aspx.cs#L33

pdfOptions.ExportFilters = true;
pdfOptions.DashboardStatePosition = DashboardStateExportPosition.Below;

asp-net-mvc-dashboard-implement-server-side-export/CS/MvcDashboard_ServerExport/Controllers/HomeController.cs#L25

pdfOptions.ExportFilters = true;
pdfOptions.DashboardStatePosition = DashboardStateExportPosition.Below;

VB.NET

web-forms-dashboard-implement-server-side-export/VB/ASPxDashboard_ServerExport/Default.aspx.vb#L54

pdfOptions.ExportFilters = True
pdfOptions.DashboardStatePosition = DashboardStateExportPosition.Below

asp-net-mvc-dashboard-implement-server-side-export/VB/MvcDashboard_ServerExport/Controllers/HomeController.vb#L23

pdfOptions.ExportFilters = True
pdfOptions.DashboardStatePosition = DashboardStateExportPosition.Below
Dim dateTimeNow As String = Date.Now.ToString("yyyyMMddHHmmss")