constructor

• new CustomViewCollection(a): CustomViewCollection

• Parameters

  • a: Workbook

  Returns CustomViewCollection

Static $t

count

• get count(): number

• Gets the number of custom views in the collection. The number of custom views in the collection.

  Returns number

[iterator]

• [iterator](): EnumeratorWrapper<CustomView>

• Returns EnumeratorWrapper<CustomView>

add

• add(name, savePrintOptions, saveHiddenRowsAndColumns): CustomView

• Adds a new custom view to the collection.

  Throws

  [[ArgumentNullException]] 'name' is a null or empty.

  Throws

  [[ArgumentException]] 'name' is the name of another custom view in the collection (custom view names are compared case-insensitively).

  Parameters

  • name: string

    The name to give the newly created custom view.

  • savePrintOptions: boolean

    True to save print options for each worksheet with the custom view; False otherwise.

  • saveHiddenRowsAndColumns: boolean

    True to save information about hidden rows and columns for each worksheet with the custom view; False otherwise.

  Returns CustomView

clear

• clear(): void

• Clears all custom views from the collection.

  Returns void

contains

• contains(customView): boolean

• Determines whether a custom view is in this collection.

  Parameters

  • customView: CustomView

    The custom view to locate in the collection.

  Returns boolean

item

• item(index): CustomView

• Gets the custom view at the specified index. The custom view 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 custom view to get.

  Returns CustomView

removeAt

• removeAt(index): void

• Removes the custom view at the specified index from the collection.

  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 custom view in the collection.

  Returns void

remove_1

• remove_1(customView): boolean

• Removes the specified custom view from the collection.

  Parameters

  • customView: CustomView

    The custom view to remove from the collection.

  Returns boolean