Class SheetCollection

A collection of sheets in a workbook.

See

Sheet
Worksheet @see@see

Hierarchy

Base
- SheetCollection

Implements

IList$1<Sheet>

Constructors

constructor

new SheetCollection(a: Workbook): SheetCollection
Overrides Base.constructor
- Defined in igniteui-angular-excel/lib/DefaultStyleHelper_combined.d.ts:22407
Parameters
- a: Workbook
Returns SheetCollection

Properties

$type

$type: Type

`Static` $t

$t: Type

`Static` nextHashCode

nextHashCode: number

Accessors

count

get count(): number
Implementation of IList$1.count
- Defined in igniteui-angular-excel/lib/DefaultStyleHelper_combined.d.ts:22575
Gets the number of sheets in the collection. The number of sheets in the collection.

Returns number

Methods

[iterator]

[iterator](): EnumeratorWrapper<Sheet>
- Defined in igniteui-angular-excel/lib/DefaultStyleHelper_combined.d.ts:22444
Returns EnumeratorWrapper<Sheet>

add

add(name: string, type: SheetType): Sheet
Implementation of IList$1.add
- Defined in igniteui-angular-excel/lib/DefaultStyleHelper_combined.d.ts:22427
Creates a new Sheet and adds it to the collection.

If the workbook originally had no sheets, the newly added sheet will become the selected sheet of the workbook. This can be changed after more sheets are added by setting the WindowOptions.selectedSheet of the Workbook.

Throws
ArgumentNullException 'name' is null or empty.

Throws
ArgumentException 'name' contains the invalid characters: ':', '', '/', '?', '*', '[', or ']'.

Throws
ArgumentException 'name' exceeds 31 characters in length.

Throws
ArgumentException 'name' is being used as the name of another sheet (sheet names are case-insensitively compared).

Returns
The Sheet created with the specified name.

Parameters
- name: string
  
  The name to give the new Sheet.
- type: SheetType
  
  An enumeration indicating the type of sheet to create
Returns Sheet

clear

clear(): void
Implementation of IList$1.clear
- Defined in igniteui-angular-excel/lib/DefaultStyleHelper_combined.d.ts:22498
Clears all sheets from the collection.

If there are any NamedReference instances in the Workbook.namedReferences collection with a worksheet for a scope, they will be removed from the Workbook.

Returns void

contains

contains(sheet: Sheet): boolean
Implementation of IList$1.contains
- Defined in igniteui-angular-excel/lib/DefaultStyleHelper_combined.d.ts:22508
Determines whether a sheet is in the collection.

Returns
True if the sheet is found; False otherwise.

Parameters
- sheet: Sheet
  
  The sheet to locate in the collection.
Returns boolean

equals

equals(other: any): boolean
Inherited from Base.equals
- Defined in igniteui-angular-core/lib/type.d.ts:10
Parameters
- other: any
Returns boolean

exists

exists(name: string): boolean
- Defined in igniteui-angular-excel/lib/DefaultStyleHelper_combined.d.ts:22514
Determines whether a sheet with the specified name exists in the collection.

Returns
True if a sheet with the specified name is found; False otherwise.

Parameters
- name: string
  
  The name of the sheet to search for. The name is compared case-insensitively.
Returns boolean

getHashCode

getHashCode(): number
Inherited from Base.getHashCode
- Defined in igniteui-angular-core/lib/type.d.ts:17
Returns number

indexOf

indexOf(sheet: Sheet): number
Implementation of IList$1.indexOf
- Defined in igniteui-angular-excel/lib/DefaultStyleHelper_combined.d.ts:22521
Gets the index of the specified sheet in the collection.

Returns
The index of the specified sheet in the collection.

See
Sheet.sheetIndex

Parameters
- sheet: Sheet
  
  The sheet of which to get the index.
Returns number

item

item(index: number): Sheet
Implementation of IList$1.item
- Defined in igniteui-angular-excel/lib/DefaultStyleHelper_combined.d.ts:22467
Gets the sheet at the specified index. The sheet at the specified index.

Throws
ArgumentOutOfRangeException 'index' is less than zero or 'index' is greater than or equal to count.

Parameters
- index: number
  
  The zero-based index of the sheet to get.
Returns Sheet
item(name: string): Sheet
Implementation of IList$1.item
- Defined in igniteui-angular-excel/lib/DefaultStyleHelper_combined.d.ts:22478
Gets the sheet with the specified name.

Sheet names are compared case-insensitively.
The sheet with the specified name.
Throws
InvalidOperationException A sheet with the specified name does not exist in the collection.

See
Sheet.name

Parameters
- name: string
  
  The name of the sheet to get.
Returns Sheet

memberwiseClone

memberwiseClone(): Base
Inherited from Base.memberwiseClone
- Defined in igniteui-angular-core/lib/type.d.ts:19
Returns Base

removeAt

removeAt(index: number): void
Implementation of IList$1.removeAt
- Defined in igniteui-angular-excel/lib/DefaultStyleHelper_combined.d.ts:22554
Removes the sheet at the specified index from the collection.

If there are any NamedReference instances in the Workbook.namedReferences collection with the worksheet to remove as their scope, they will be removed from the Workbook.

Throws
ArgumentOutOfRangeException 'index' is less than zero or 'index' is greater than or equal to count.

Parameters
- index: number
  
  The index of the sheet to remove from the collection.
Returns void

remove_1

remove_1(sheet: Sheet): boolean
- Defined in igniteui-angular-excel/lib/DefaultStyleHelper_combined.d.ts:22544
Removes the specified sheet from the collection.

If there are any NamedReference instances in the Workbook.namedReferences collection with the worksheet to remove as their scope, they will be removed from the Workbook.

Returns
True if the sheet was successfully removed from the collection; False if the sheet did not exist in the collection.

Parameters
- sheet: Sheet
  
  The sheet to remove from the collection.
Returns boolean

`Static` compare

compare(item1: any, item2: any): number
Inherited from Base.compare
- Defined in igniteui-angular-core/lib/type.d.ts:14
Parameters
- item1: any
- item2: any
Returns number

`Static` compareSimple

compareSimple(item1: any, item2: any): number
Inherited from Base.compareSimple
- Defined in igniteui-angular-core/lib/type.d.ts:13
Parameters
- item1: any
- item2: any
Returns number

`Static` equalsSimple

equalsSimple(item1: any, item2: any): boolean
Inherited from Base.equalsSimple
- Defined in igniteui-angular-core/lib/type.d.ts:12
Parameters
- item1: any
- item2: any
Returns boolean

`Static` equalsStatic

equalsStatic(a: any, b: any): boolean
Inherited from Base.equalsStatic
- Defined in igniteui-angular-core/lib/type.d.ts:11
Parameters
- a: any
- b: any
Returns boolean

`Static` getArrayOfProperties

getArrayOfProperties(obj: any): any[]
Inherited from Base.getArrayOfProperties
- Defined in igniteui-angular-core/lib/type.d.ts:22
Parameters
- obj: any
Returns any[]

`Static` getArrayOfValues

getArrayOfValues(obj: any): any[]
Inherited from Base.getArrayOfValues
- Defined in igniteui-angular-core/lib/type.d.ts:21
Parameters
- obj: any
Returns any[]

`Static` getHashCodeStatic

getHashCodeStatic(obj: any): number
Inherited from Base.getHashCodeStatic
- Defined in igniteui-angular-core/lib/type.d.ts:18
Parameters
- obj: any
Returns number

`Static` referenceEquals

referenceEquals(a: any, b: any): boolean
Inherited from Base.referenceEquals
- Defined in igniteui-angular-core/lib/type.d.ts:20
Parameters
- a: any
- b: any
Returns boolean

`Static` staticInit

staticInit(): void
- Defined in igniteui-angular-excel/lib/DefaultStyleHelper_combined.d.ts:22406
Returns void

Class SheetCollection

See

Hierarchy

Hierarchy

Implements

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

a: Workbook

Returns SheetCollection

Properties

$type

Static $t

Static nextHashCode

Accessors

count

Returns number

Methods

[iterator]

Returns EnumeratorWrapper<Sheet>

add

Throws

Throws

Throws

Throws

Returns

Parameters

name: string

type: SheetType

Returns Sheet

clear

Returns void

contains

Returns

Parameters

sheet: Sheet

Returns boolean

equals

Parameters

other: any

Returns boolean

exists

Returns

Parameters

name: string

Returns boolean

getHashCode

Returns number

indexOf

Returns

See

Parameters

sheet: Sheet

Returns number

item

Throws

Parameters

index: number

Returns Sheet

Throws

See

Parameters

name: string

Returns Sheet

memberwiseClone

Returns Base

removeAt

Throws

Parameters

index: number

Returns void

remove_1

Returns

Parameters

sheet: Sheet

Returns boolean

`Static` $t

`Static` nextHashCode

`Static` compare

`Static` compareSimple

`Static` equalsSimple

`Static` equalsStatic

`Static` getArrayOfProperties

`Static` getArrayOfValues

`Static` getHashCodeStatic

`Static` referenceEquals

`Static` staticInit