constructor

• new SheetCollection(a): SheetCollection

• Parameters

  • a: Workbook

  Returns SheetCollection

Static $t

count

• get count(): number

• Gets the number of sheets in the collection. The number of sheets in the collection.

  Returns number

[iterator]

• [iterator](): EnumeratorWrapper<Sheet>

• Returns EnumeratorWrapper<Sheet>

add

• add(name, type): Sheet

• 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).

  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

• 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): boolean

• Determines whether a sheet is in the collection.

  Parameters

  • sheet: Sheet

    The sheet to locate in the collection.

  Returns boolean

exists

• exists(name): boolean

• Determines whether a sheet with the specified name exists in the collection.

  Parameters

  • name: string

    The name of the sheet to search for. The name is compared case-insensitively.

  Returns boolean

indexOf

• indexOf(sheet): number

• Gets 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): Sheet

• 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): Sheet

• 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

removeAt

• removeAt(index): void

• 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): boolean

• 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]].

  Parameters

  • sheet: Sheet

    The sheet to remove from the collection.

  Returns boolean

Static staticInit

• staticInit(): void

• Returns void