XlExportOptionsBase.SheetName Property

Gets or sets a name of the sheet in the created XLS file to which a document is exported.

Namespace: DevExpress.XtraPrinting

Assembly: DevExpress.Printing.v22.1.Core.dll

Declaration

C#

[DefaultValue("Sheet")]
public string SheetName { get; set; }

VB.NET

<DefaultValue("Sheet")>
Public Property SheetName As String

Property Value

Type	Default	Description
String	“Sheet”	A String representing the sheet name set in the resulting XLS file.

Property Paths

You can access this nested property as listed below:

Library	Object Type	Path to SheetName
Cross-Platform Class Library	ExportOptions	.Xlsx.SheetName
WPF Controls	ExportOptionsContainer	.Xlsx.SheetName

Remarks

By default, the SheetName property returns an empty string, which means that the sheet name is equal to the Document.Name property value.

Related GitHub Examples

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

Reporting_how-to-customize-how-a-document-is-exported-from-print-preview-e172/CS/WindowsFormsApplication1/Form1.cs#L75

options.Xls.ShowGridLines = true;
options.Xls.SheetName = "Page 1";
options.Xls.TextExportMode = TextExportMode.Value;

Reporting_how-to-export-reports-to-different-sheets-in-an-xlsx-file-by-using-spreadsheet-e4892/CS/WindowsFormsApplication1/Form1.cs#L34

report2.CreateDocument(false);
report.ExportToXlsx("test1.xlsx", new DevExpress.XtraPrinting.XlsxExportOptions() { SheetName = "report1" });
report2.ExportToXlsx("test2.xlsx", new DevExpress.XtraPrinting.XlsxExportOptions() { SheetName = "report2" });

XAF_how-to-customize-export-options-of-the-printing-system-in-winforms-e2108/CS/WinSolution.Module.Win/ConfigurePrintingSystemViewController.cs#L41

// XLS-specific options:
xlsExportOptions.SheetName = "CustomXlsSheetTitle";
xlsExportOptions.ShowGridLines = true;

Reporting_how-to-export-a-report-to-xlsx-format-e1539/CS/ExportToXLSX/Form1.cs#L27

xlsxOptions.ExportHyperlinks = true;
xlsxOptions.SheetName = "My Sheet";

how-to-customize-the-gridcontrols-data-aware-export-output-t247610/CS/GridDataAwareExportCustomization/Form1.cs#L44

// Specify a name of the sheet in the created XLSX file.
options.SheetName = "DevAV price";

VB.NET

Reporting_how-to-customize-how-a-document-is-exported-from-print-preview-e172/VB/WindowsFormsApplication1/Form1.vb#L75

options.Xls.ShowGridLines = True
options.Xls.SheetName = "Page 1"
options.Xls.TextExportMode = TextExportMode.Value

Reporting_how-to-export-reports-to-different-sheets-in-an-xlsx-file-by-using-spreadsheet-e4892/VB/WindowsFormsApplication1/Form1.vb#L36

report2.CreateDocument(False)
report.ExportToXlsx("test1.xlsx", New DevExpress.XtraPrinting.XlsxExportOptions() With {.SheetName = "report1"})
report2.ExportToXlsx("test2.xlsx", New DevExpress.XtraPrinting.XlsxExportOptions() With {.SheetName = "report2"})

XAF_how-to-customize-export-options-of-the-printing-system-in-winforms-e2108/VB/WinSolution.Module.Win/ConfigurePrintingSystemViewController.vb#L42

' XLS-specific options:
xlsExportOptions.SheetName = "CustomXlsSheetTitle"
xlsExportOptions.ShowGridLines = True

Reporting_how-to-export-a-report-to-xlsx-format-e1539/VB/ExportToXLSX/Form1.vb#L29

xlsxOptions.ExportHyperlinks = True
xlsxOptions.SheetName = "My Sheet"

how-to-customize-the-gridcontrols-data-aware-export-output-t247610/VB/GridDataAwareExportCustomization/Form1.vb#L47

' Specify a name of the sheet in the created XLSX file.
options.SheetName = "DevAV price"