DashboardPdfExportOptions.ShowTitle Property

Gets or sets whether a dashboard title (or dashboard item’s caption) is included as the exported document title.

Namespace: DevExpress.DashboardCommon

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

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

[DefaultValue(DefaultBoolean.Default)]
public DefaultBoolean ShowTitle { get; set; }

VB.NET

<DefaultValue(DefaultBoolean.Default)>
Public Property ShowTitle As DefaultBoolean

Property Value

Type	Default	Description
DefaultBoolean	Default	A DefaultBoolean value that specifies whether a dashboard title (or dashboard item’s caption) is included as the exported document title.

Available values:

Name	Description	Return Value
True	The value is true.	0
False	The value is false.	1
Default	The value is specified by a global option or a higher-level object.	2

Property Paths

You can access this nested property as listed below:

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

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ShowTitle 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-pdf-export-with-filter-values-on-different-pages/CS/ASPxDashboard_ServerExport/Default.aspx.cs#L36

DashboardPdfExportOptions pdfOptions = new DashboardPdfExportOptions();
pdfOptions.ShowTitle = DevExpress.Utils.DefaultBoolean.False;
ASPxDashboardExporter exporter = new ASPxDashboardExporter(ASPxDashboard1);

VB.NET

web-forms-dashboard-pdf-export-with-filter-values-on-different-pages/VB/ASPxDashboard_ServerExport/Default.aspx.vb#L36

Dim pdfOptions As New DashboardPdfExportOptions()
pdfOptions.ShowTitle = DevExpress.Utils.DefaultBoolean.False
Dim exporter As New ASPxDashboardExporter(ASPxDashboard1)