Back to all docs
API Reference / Telerik.Windows.Documents.Spreadsheet.Model / SheetCollection
New to Telerik Document Processing? Start a free 30-day trial

SheetCollection

Class

Ordered collection of sheets in a workbook, managing sheet creation, insertion, removal, visibility, and active sheet tracking with validation and event notifications.

Definition

Namespace:Telerik.Windows.Documents.Spreadsheet.Model

Assembly:Telerik.Windows.Documents.Spreadsheet.dll

Syntax:
C#
public class SheetCollection : IEnumerable<Sheet>, IEnumerable

Inheritance: objectSheetCollection

Implements: IEnumerableIEnumerable<Sheet>

Events

ActiveSheetChanged

Raised when the active sheet reference changes, allowing UI to switch displayed content.

C#
public event EventHandler ActiveSheetChanged

ActiveSheetIndexChanged

Raised when the active sheet's index changes, allowing UI to update tab selection.

C#
public event EventHandler ActiveSheetIndexChanged

Changed

Raised after a sheet operation completes (add, remove, hide, unhide, move, clear), providing change details.

C#
public event EventHandler<SheetCollectionChangedEventArgs> Changed

Methods

Add(SheetType)

Creates a new sheet of the specified type with a generated unique name and appends it to the collection.

C#
public Sheet Add(SheetType type)
Parameters:typeSheetType

The type of sheet.

Returns:

Sheet

The newly created sheet.

Contains(Sheet)

Checks whether the specified sheet exists in this collection.

C#
public bool Contains(Sheet sheet)
Parameters:sheetSheet

The sheet.

Returns:

bool

The value indicating whether the sheet is contained in the collection.

Contains(string)

Checks whether a sheet with the specified name exists in the collection, using case-insensitive comparison.

C#
public bool Contains(string sheetName)
Parameters:sheetNamestring

The name of the sheet.

Returns:

bool

The value indicating whether a sheet with the specified name is contained in the collection.

GetByName(string)

Retrieves the sheet with the specified name using case-insensitive comparison, or null if not found.

C#
public Sheet GetByName(string sheetName)
Parameters:sheetNamestring

The name of the sheet.

Returns:

Sheet

The sheet.

GetEnumerator()

Returns an enumerator for iterating through all sheets in order.

C#
public IEnumerator<Sheet> GetEnumerator()
Returns:

IEnumerator<Sheet>

A IEnumerator<T> that can be used to iterate through the collection.

Implements: IEnumerable<Sheet>.GetEnumerator()

Hide()

Hides the currently active sheet, ensuring at least one visible sheet remains.

C#
public void Hide()

Hide(int)

Hides the sheet at the specified index, ensuring at least one visible sheet remains.

C#
public void Hide(int index)
Parameters:indexint

The index.

Hide(Sheet)

Hides the specified sheet, ensuring at least one visible sheet remains.

C#
public void Hide(Sheet sheet)
Parameters:sheetSheet

The sheet.

IndexOf(Sheet)

Searches for the specified sheet and returns its zero-based index, or -1 if not found.

C#
public int IndexOf(Sheet sheet)
Parameters:sheetSheet

The sheet.

Returns:

int

The index of the sheet.

IndexOf(string)

Searches for a sheet with the specified name using case-insensitive comparison and returns its zero-based index, or -1 if not found.

C#
public int IndexOf(string sheetName)
Parameters:sheetNamestring

The name of the sheet.

Returns:

int

The index of the sheet.

Insert(int, SheetType)

Creates a new sheet of the specified type with a generated unique name and inserts it at the specified index.

C#
public Sheet Insert(int index, SheetType type)
Parameters:indexint

The index.

typeSheetType

The type.

Returns:

Sheet

The newly created sheet.

Insert(SheetType)

Creates a new sheet of the specified type with a generated unique name and inserts it at the active sheet's index.

C#
public Sheet Insert(SheetType type)
Parameters:typeSheetType

The type.

Returns:

Sheet

The newly created sheet.

Move(int, int, int)

Relocates a contiguous range of sheets from the source index to the destination index, shifting other sheets as needed.

C#
public void Move(int fromIndex, int itemCount, int toIndex)
Parameters:fromIndexint

From index.

itemCountint

The item count.

toIndexint

To index.

OnActiveSheetChanged()

Raises the ActiveSheetChanged event, notifying subscribers of sheet change.

C#
protected virtual void OnActiveSheetChanged()

OnActiveSheetIndexChanged()

Raises the ActiveSheetIndexChanged event, notifying subscribers of index change.

C#
protected virtual void OnActiveSheetIndexChanged()

OnChanged(SheetCollectionChangedEventArgs)

Raises the Changed event, notifying subscribers of completed collection modification.

C#
protected virtual void OnChanged(SheetCollectionChangedEventArgs args)
Parameters:argsSheetCollectionChangedEventArgs

The SheetCollectionChangedEventArgs instance containing the event data.

Remove()

Removes the currently active sheet from the collection, ensuring at least one visible sheet remains.

C#
public void Remove()

Remove(Sheet)

Removes the specified sheet from the collection and returns true if found, false otherwise.

C#
public bool Remove(Sheet sheet)
Parameters:sheetSheet

The sheet.

Returns:

bool

The value indicating whether the specified sheet was found.

Remove(string)

Removes the sheet with the specified name and returns true if found, false otherwise.

C#
public bool Remove(string sheetName)
Parameters:sheetNamestring

The name of the sheet.

Returns:

bool

The value indicating whether a sheet with a specified name was found.

RemoveAt(int)

Removes the sheet at the specified index, ensuring at least one visible sheet remains.

C#
public void RemoveAt(int index)
Parameters:indexint

The index.

Unhide(int)

Makes the sheet at the specified index visible and sets it as the active sheet.

C#
public void Unhide(int index)
Parameters:indexint

The index.

Unhide(Sheet)

Makes the specified sheet visible and sets it as the active sheet.

C#
public void Unhide(Sheet sheet)
Parameters:sheetSheet

The sheet.

Properties

ActiveSheet

Currently selected sheet displayed to the user; must be a sheet from this collection.

C#
public Sheet ActiveSheet { get; set; }
Property Value:

The active sheet.

ActiveSheetIndex

Zero-based index of the active sheet, or -1 if no sheets exist; setting updates both index and ActiveSheet.

C#
public int ActiveSheetIndex { get; set; }
Property Value:

The index of the active sheet.

Count

Total number of sheets in the collection, including hidden and very hidden sheets.

C#
public int Count { get; }
Property Value:

The count of the sheets.

this[int]

Retrieves the sheet at the specified zero-based index.

C#
public Sheet this[int index] { get; }
Parameters:indexintProperty Value:

The sheet.

this[string]

Retrieves the sheet with the specified name, using case-insensitive comparison.

C#
public Sheet this[string sheetName] { get; }
Parameters:sheetNamestringProperty Value:

The sheet.

Workbook

Workbook that owns this collection, providing the context for sheet operations.

C#
public Workbook Workbook { get; }
Property Value:

The workbook.

In this article
DefinitionEventsActiveSheetChangedActiveSheetIndexChangedChangedMethodsAdd(SheetType)Contains(Sheet)Contains(string)GetByName(string)GetEnumerator()Hide()Hide(int)Hide(Sheet)IndexOf(Sheet)IndexOf(string)Insert(int, SheetType)Insert(SheetType)Move(int, int, int)OnActiveSheetChanged()OnActiveSheetIndexChanged()OnChanged(SheetCollectionChangedEventArgs)Remove()Remove(Sheet)Remove(string)RemoveAt(int)Unhide(int)Unhide(Sheet)PropertiesActiveSheetActiveSheetIndexCountthis[int]this[string]Workbook
Not finding the help you need?
Contact Support