A collection of hidden WorksheetColumn instances.

The columns in this collection do not necessarily have their RowColumnBase.hidden property set to True. This collection applies to a worksheet, but belongs to a CustomView. When the CustomView which owns this collection is applied, the columns in this collection will have their RowColumnBase.hidden property set to True. All other columns in the associated worksheet will be made visible.

See

CustomView.getHiddenColumns

Hierarchy

Hierarchy

  • Base
    • HiddenColumnCollection

Implements

Constructors

Properties

$type: Type
$t: Type
nextHashCode: number

Accessors

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

    Returns number

  • get worksheet(): Worksheet
  • Gets the worksheet associated with this collection. The worksheet associated with this collection.

    Returns Worksheet

Methods

  • Adds a column to the collection.

    This collection does not allow duplicate values. If the specified column already exists in the collection, nothing will happen. This collection also keeps itself sorted, so the column added will not necessarily be added at the end of the collection.

    Throws

    ArgumentNullException 'column' is null.

    Throws

    ArgumentException 'column' does not belong to the same worksheet this collection is associated with.

    Parameters

    • column: WorksheetColumn

      The column to be added to the hidden columns collection.

    Returns void

  • Clears all columns from the collection.

    Returns void

  • Determines whether the specified column exists in the collection.

    Returns

    True if the column exists in the collection; False otherwise or if the specified column is null.

    Parameters

    Returns boolean

  • Parameters

    • other: any

    Returns boolean

  • Returns number

  • Gets the column at the specified index. The column at the specified index.

    Throws

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

    Parameters

    • a: number

    Returns WorksheetColumn

  • Removes the column at the specified index in 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 column in the collection.

    Returns void

  • Removes the specified column from the collection if it exists.

    Returns

    True if the column existed in the collection and was removed; False otherwise or if the specified column is null.

    Parameters

    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