Class FilteredSheetCollection<T>

Represents a base for classes representing collections of a specific type of sheets.

Inheritance

System.Object

FilteredSheetCollection<T>

WorksheetCollection

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Telerik.Windows.Documents.Spreadsheet.Model

Assembly: Telerik.Windows.Documents.Spreadsheet.dll

Syntax

public abstract class FilteredSheetCollection<T> : IEnumerable<T>, IEnumerable where T : Sheet

Type Parameters

T The type of the sheet.

Properties

Count

Gets the item count.

Declaration

public int Count { get; }

Property Value

System.Int32 The item count.

Item[Int32]

Gets the sheet at the specified index.

Declaration

public T this[int index] { get; }

Parameters

System.Int32 index

Property Value

T

Item[String]

Gets the sheet with the specified sheet name.

Declaration

public T this[string sheetName] { get; }

Parameters

System.String sheetName

Property Value

T

Workbook

Gets the workbook.

Declaration

public Workbook Workbook { get; }

Property Value

Workbook The workbook.

Methods

Add()

Creates a new sheet and adds it to the collection.

Declaration

public T Add()

Returns

T The created sheet.

Clear()

Clears this instance.

Declaration

public void Clear()

Contains(T)

Determines whether the collection contains the specified sheet.

Declaration

public bool Contains(T item)

Parameters

T item The item.

Returns

System.Boolean The value indicating whether the collection contains the specified sheet.

Contains(String)

Determines whether the collection contains a sheet with the specified sheet name.

Declaration

public bool Contains(string sheetName)

Parameters

System.String sheetName Name of the sheet.

Returns

System.Boolean The value indicating whether the collection contains a sheet with the specified sheet name.

GetByName(String)

Gets the sheet by name. The search is case insensitive.

Declaration

public T GetByName(string sheetName)

Parameters

System.String sheetName Name of the sheet.

Returns

T The sheet.

GetEnumerator()

Returns an enumerator that iterates through the collection.

Declaration

public IEnumerator<T> GetEnumerator()

Returns

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

Implements

System.Collections.Generic.IEnumerable<T>.GetEnumerator()

Hide(T)

Hides a specified sheet.

Declaration

public void Hide(T sheet)

Parameters

T sheet The sheet.

Hide(Int32)

Hides a sheet at a specified index.

Declaration

public void Hide(int index)

Parameters

System.Int32 index The index.

IndexOf(T)

Searches for the specified item and returns the zero-based index of the first occurrence within the entire collection.

Declaration

public int IndexOf(T item)

Parameters

T item The item.

Returns

System.Int32 The index of the item.

IndexOf(String)

Searches for the specified item by its name and returns the zero-based index of the first occurrence within the entire collection. .

Declaration

public int IndexOf(string sheetName)

Parameters

System.String sheetName Name of the sheet.

Returns

System.Int32 The index of the item

Insert(Int32)

Creates a new sheet and inserts it in the collection at the specified index.

Declaration

public T Insert(int index)

Parameters

System.Int32 index The index.

Returns

T The created sheet.

Remove(T)

Removes the specified item.

Declaration

public bool Remove(T item)

Parameters

T item The item.

Returns

System.Boolean The value indicating whether the specified sheet was found.

Remove(String)

Removes a sheet by the specified sheet name.

Declaration

public bool Remove(string sheetName)

Parameters

System.String sheetName Name of the sheet.

Returns

System.Boolean The value indicating whether a sheet by the specified name was found.

RemoveAt(Int32)

Removes a sheet at the specified index.

Declaration

public void RemoveAt(int index)

Parameters

System.Int32 index The index.

Unhide(T)

Unhides a specified sheet.

Declaration

public void Unhide(T sheet)

Parameters

T sheet The sheet.

Unhide(Int32)

Unhides a sheet at a specified index.

Declaration

public void Unhide(int index)

Parameters

System.Int32 index The index.

Explicit Interface Implementations

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

Declaration

IEnumerator IEnumerable.GetEnumerator()

Returns

System.Collections.IEnumerator An System.Collections.IEnumerator object that can be used to iterate through the collection.

Implements

System.Collections.IEnumerable.GetEnumerator()