WorksheetCollection.Item[String] Property

Gets a worksheet by its name.

Namespace: DevExpress.Spreadsheet

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

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

Worksheet this[string name] { get; }

VB.NET

ReadOnly Property Item(name As String) As Worksheet

Parameters

Name	Type	Description
name	String	A String value that specifies the name of the worksheet to get.

Property Value

Type	Description
Worksheet	A Worksheet object that is the worksheet with the specified name.

Remarks

Use the Item property to obtain a worksheet by its name from the workbook’s collection of worksheets. When searching, the name parameter value is compared to the Worksheet.Name property of worksheet objects. If no matches are found, an exception is thrown. To check whether a worksheet with the specified name exists in the collection, use the Contains property.

A worksheet can be also accessed by its index in the collection.

Example

This example demonstrates how to access worksheets in a workbook. Use the Workbook.Worksheets property to get a collection of worksheets contained in a workbook (the WorksheetCollection object).

To get an individual worksheet by its index or name, use the WorksheetCollection.Item property.

C#

using DevExpress.Spreadsheet;
// ...

Workbook workbook = new Workbook();

// Access a collection of worksheets.
WorksheetCollection worksheets = workbook.Worksheets;

// Access a worksheet by its index.
Worksheet worksheet1 = workbook.Worksheets[0];

// Access a worksheet by its name.
Worksheet worksheet2 = workbook.Worksheets["Sheet2"];

VB.NET

Imports DevExpress.Spreadsheet
' ...

Dim workbook As New Workbook()

' Access a collection of worksheets.
Dim worksheets As WorksheetCollection = workbook.Worksheets

' Access a worksheet by its index.
Dim worksheet1 As Worksheet = workbook.Worksheets(0)

' Access a worksheet by its name.
Dim worksheet2 As Worksheet = workbook.Worksheets("Sheet2")