Worksheet.Name Property

Gets or sets the name of the worksheet .

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v23.2.Core.dll

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

string Name { get; set; }

VB.NET

Property Name As String

Property Value

Type	Description
String	A String value which specifies the worksheet name.

Remarks

When naming a worksheet, take into account the following constraints.

• A worksheet name must not be equal to a name that is already contained in the collection of existing worksheets (IWorkbook.Worksheets).
• 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.

To add a new worksheet under the specified name to the workbook, use the WorksheetCollection.Add or WorksheetCollection.Insert method with the worksheet name passed as a parameter.

Example

This example demonstrates how to rename a worksheet. To do this, use the Worksheet.Name property of the corresponding Worksheet object.

View Example

WorksheetActions.cs

// Change the name of the second worksheet.
workbook.Worksheets[1].Name = "Renamed Sheet";

WorksheetActions.vb

' Change the name of the second worksheet.
workbook.Worksheets(1).Name = "Renamed Sheet"

Related GitHub Examples

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

winforms-spreadsheet-use-custom-cell-editors/CS/DevAVInvoicing/Form1.cs#L116

Worksheet sheet = spreadsheetControl1.ActiveWorksheet;
if (sheet.Name == "Invoice") {
    DefinedName invoiceItems = sheet.DefinedNames.GetDefinedName("InvoiceItems");

wpf-spreadsheetcontrol-api-part-1/CS/SpreadsheetControl_WPF_API/SpreadsheetActions/WorksheetActions.cs#L46

// Add a new worksheet under the specified name.
workbook.Worksheets.Add().Name = "TestSheet1";

spreadsheet-document-api-examples-part1/CS/SpreadsheetExamples/SpreadsheetActions/WorksheetActions.cs#L39

// Add a new worksheet under the specified name.
workbook.Worksheets.Add().Name = "TestSheet1";

winforms-spreadsheetcontrol-api-part1/CS/SpreadsheetControl/SpreadsheetActions/WorksheetActions.cs#L37

// Add a new worksheet under the specified name.
workbook.Worksheets.Add().Name = "TestSheet1";

winforms-spreadsheet-import-data-from-a-datatable-instance/CS/Form1.cs#L18

        workbook.Worksheets.RemoveAt(i);
    workbook.Worksheets[0].Name = "Default";
}

VB.NET

winforms-spreadsheet-use-custom-cell-editors/VB/DevAVInvoicing/Form1.vb#L107

Dim sheet As Worksheet = spreadsheetControl1.ActiveWorksheet
If Equals(sheet.Name, "Invoice") Then
    Dim invoiceItems As DefinedName = sheet.DefinedNames.GetDefinedName("InvoiceItems")

wpf-spreadsheetcontrol-api-part-1/VB/SpreadsheetControl_WPF_API/SpreadsheetActions/WorksheetActions.vb#L45

' Add a new worksheet under the specified name.
workbook.Worksheets.Add().Name = "TestSheet1"

spreadsheet-document-api-examples-part1/VB/SpreadsheetExamples/SpreadsheetActions/WorksheetActions.vb#L49

' Add a new worksheet under the specified name.
workbook.Worksheets.Add().Name = "TestSheet1"
workbook.Worksheets.Add("TestSheet2")

winforms-spreadsheetcontrol-api-part1/VB/SpreadsheetControl/SpreadsheetActions/WorksheetActions.vb#L41

' Add a new worksheet under the specified name.
workbook.Worksheets.Add().Name = "TestSheet1"

winforms-spreadsheet-import-data-from-a-datatable-instance/VB/Form1.vb#L21

    Next i
    workbook.Worksheets(0).Name = "Default"
End Sub