The requested page is not available for the requested platform. You are viewing the content for .NET Framework 4.5.2+ platform.
.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
.NET Core 3.0+
Row

IWorkbook.Worksheets Property

Gets a collection of worksheets contained in the workbook.

Namespace: DevExpress.Spreadsheet

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

Declaration

WorksheetCollection Worksheets { get; }
ReadOnly Property Worksheets As WorksheetCollection
WorksheetCollection Worksheets { get; }
ReadOnly Property Worksheets As WorksheetCollection
WorksheetCollection Worksheets { get; }
ReadOnly Property Worksheets As WorksheetCollection

Property Value

Type Description
WorksheetCollection

A WorksheetCollection object that is a collection of worksheets.

Property Value

Type Description
WorksheetCollection

A WorksheetCollection object that is a collection of worksheets.

Property Value

Type Description
WorksheetCollection

A WorksheetCollection object that is a collection of worksheets.

Remarks

A workbook consists of one or more worksheets that are stored within the WorksheetCollection collection returned by the Worksheets property. Use members of the WorksheetCollection object to manage a workbook's set of worksheets. For example, you can access an individual worksheet by it's name or index, add a new worksheet, remove an existing worksheet, assign an active worksheet, etc.

For more examples on how to manage worksheets, see the Worksheets section.

Examples

This example demonstrates how to access worksheets in a workbook. Use the IWorkbook.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;
// ...

IWorkbook workbook = spreadsheetControl1.Document;

// 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