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.v25.2.Core.dll

NuGet Package : DevExpress.Printing.Core

Declaration

• C#
• VB.NET

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

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

Property Value

A String representing the sheet name set in the resulting XLS file.

|

Remarks

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

When naming a worksheet, consider the following constraints.

• A worksheet name must be unique.
• A worksheet name must not exceed 31 characters.
• A worksheet name must not contain the following symbols: , /, ?, :, *, [or]
• The worksheet name must not start and end with a single quote (‘).
• A worksheet name must not be an empty string.

An ArgumentException occurs when the sheet name does not meet the aforementioned requirements.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference 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#
• VB.NET

winforms-grid-customize-data-aware-export-output/CS/GridDataAwareExportCustomization/Form1.cs#L44

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

winforms-grid-customize-data-aware-export-output/VB/GridDataAwareExportCustomization/Form1.vb#L47

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

See Also

Export to XLS

XlExportOptionsBase Class

XlExportOptionsBase Members

DevExpress.XtraPrinting Namespace