A collection of CustomView instances in a workbook.

Hierarchy

Hierarchy

  • Base
    • CustomViewCollection

Implements

Constructors

Properties

$type: Type
$t: Type
nextHashCode: number

Accessors

  • get count(): number
  • Gets the number of custom views in the collection. The number of custom views in the collection.

    Returns number

Methods

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

    Returns

    The newly created CustomView instance.

    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

  • Clears all custom views from the collection.

    Returns void

  • Determines whether a custom view is in this collection.

    Returns

    True if the custom view is found; False otherwise.

    Parameters

    • customView: CustomView

      The custom view to locate in the collection.

    Returns boolean

  • Parameters

    • other: any

    Returns boolean

  • Returns number

  • 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

  • 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

  • Removes the specified custom view from the collection.

    Returns

    True if the custom view was successfully removed; False if the custom view was not in the collection.

    Parameters

    • customView: CustomView

      The custom view to remove from the collection.

    Returns boolean

  • Parameters

    • item1: any
    • item2: any

    Returns number

  • Parameters

    • item1: any
    • item2: any

    Returns number

  • Parameters

    • item1: any
    • item2: any

    Returns boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean

  • Parameters

    • obj: any

    Returns any[]

  • Parameters

    • obj: any

    Returns any[]

  • Parameters

    • obj: any

    Returns number

  • Parameters

    • a: any
    • b: any

    Returns boolean