Skip to main content
Row

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

WorksheetCollection.Item[String] Property

Gets a worksheet by its name.

Namespace: DevExpress.Spreadsheet

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

NuGet Package: DevExpress.Spreadsheet.Core

#Declaration

Worksheet this[string name] { get; }

#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.

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"];
See Also