A collection of hidden WorksheetRow instances.

The rows 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 rows in this collection will have their RowColumnBase.hidden property set to True. All other rows in the associated worksheet will be made visible.

See

CustomView.getHiddenRows

Hierarchy

Hierarchy

  • Base
    • HiddenRowCollection

Implements

Constructors

Properties

$type: Type
$t: Type
nextHashCode: number

Accessors

  • get count(): number
  • Gets the number of rows in the collection. The number of rows 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 row to the collection.

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

    Throws

    ArgumentNullException 'row' is null.

    Throws

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

    Parameters

    • row: WorksheetRow

      The row to be added to the hidden rows collection.

    Returns void

  • Clears all rows from the collection.

    Returns void

  • Determines whether the specified row exists in the collection.

    Returns

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

    Parameters

    • row: WorksheetRow

      The row to search for in the collection.

    Returns boolean

  • Parameters

    • other: any

    Returns boolean

  • Returns number

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

    Throws

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

    Parameters

    • a: number

    Returns WorksheetRow

  • Removes the row 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 row in the collection.

    Returns void

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

    Returns

    True if the row existed in the collection and was removed; False otherwise or if the specified row 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