DashboardPdfExportOptions.ExportFilters Property

Gets or sets whether to add the state of master filter items to the exported document.

Namespace: DevExpress.DashboardCommon

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

Declaration

C#

[DefaultValue(false)]
public bool ExportFilters { get; set; }

VB.NET

<DefaultValue(False)>
Public Property ExportFilters As Boolean

Property Value

Type	Default	Description
Boolean	**false**	true, to add the state of master filter items to the exported document; otherwise, false.

Property Paths

You can access this nested property as listed below:

Show 14 property paths

Object Type	Path to ExportFilters
BeforeExportDocumentEventArgs	.PdfExportOptions.ExportFilters
CustomExportBaseEventArgs	.PdfExportOptions.ExportFilters
CustomExportEventArgs	.PdfExportOptions.ExportFilters
CustomizeExportDocumentEventArgs	.PdfExportOptions.ExportFilters
ASPxDashboard	.PdfExportOptions.ExportFilters
BeforeExportDocumentWebEventArgs	.PdfExportOptions.ExportFilters
CustomExportBaseWebEventArgs	.PdfExportOptions.ExportFilters
CustomExportWebEventArgs	.PdfExportOptions.ExportFilters
CustomizeExportDocumentWebEventArgs	.PdfExportOptions.ExportFilters
DashboardExtensionSettings	.PdfExportOptions.ExportFilters
MVCxDashboard	.PdfExportOptions.ExportFilters
DashboardDesigner	.PdfExportOptions.ExportFilters
DashboardViewer	.PdfExportOptions.ExportFilters
DashboardControl	.PdfExportOptions.ExportFilters

Remarks

To specify a position of the dashboard state (that includes the state of master filter items), use the DashboardPdfExportOptions.DashboardStatePosition property.

Related GitHub Examples

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

DashboardPdfExportOptions pdfOptions = new DashboardPdfExportOptions();
pdfOptions.ExportFilters = true;
pdfOptions.DashboardStatePosition = DashboardStateExportPosition.Below;

winforms-dashboard-beforeexportdocument-event/CS/WinForms_Dashboard_BeforeExportEvent_Example/Form1.cs#L36

if (e.ExportAction == DashboardExportAction.ExportToPdf &&
    e.PdfExportOptions.ExportFilters == false)
{

VB.NET

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

Dim pdfOptions As DashboardPdfExportOptions = New DashboardPdfExportOptions()
pdfOptions.ExportFilters = True
pdfOptions.DashboardStatePosition = DashboardStateExportPosition.Below

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

Dim pdfOptions As New DashboardPdfExportOptions()
pdfOptions.ExportFilters = True
pdfOptions.DashboardStatePosition = DashboardStateExportPosition.Below

winforms-dashboard-beforeexportdocument-event/VB/WinForms_Dashboard_BeforeExportEvent_Example/Form1.vb#L32

Private Sub DashboardDesigner1_BeforeExportDocument(ByVal sender As Object, ByVal e As BeforeExportDocumentEventArgs)
    If e.ExportAction = DashboardExportAction.ExportToPdf AndAlso e.PdfExportOptions.ExportFilters = False Then
        e.HideItem(Function(item) TypeOf item Is FilterElementDashboardItem OrElse TypeOf item Is DateFilterDashboardItem)