Ignite UI API Reference

ig.excel.HiddenRowCollection

A collection of hidden WorksheetRow instances.

Remarks

The rows in this collection do not necessarily have their RowColumnBase.hidden property set to True. This collection applies to a HiddenRowCollection.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.

Dependencies

jquery-1.4.4.js
infragistics.util.js
The current widget has no options.
The current widget has no events.
  • add

    .add( row:ig.excel.WorksheetRow );

    Adds a row to the collection.

    • row
    • Type:ig.excel.WorksheetRow
    • The row to be added to the hidden rows collection.

    Exceptions

    Exception Description
    ig.ArgumentNullException row is null.
    ig.ArgumentException row does not belong to the same worksheet this collection is associated with.

    Remarks

    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.

  • clear

    .clear( );

    Clears all rows from the collection.

  • contains

    .contains( row:ig.excel.WorksheetRow );
    Return Type:
    boolean
    Return Type Description:
    True if the row exists in the collection; False otherwise or if the specified row is null.

    Determines whether the specified row exists in the collection.

    • row
    • Type:ig.excel.WorksheetRow
    • The row to search for in the collection.
  • count

    .count( );
    Return Type:
    number
    Return Type Description:
    The number of rows in the collection.

    Gets the number of rows in the collection.

  • item

    .item( index:number );
    Return Type:
    ig.excel.WorksheetRow
    Return Type Description:
    The row at the specified index.

    Gets the row at the specified index.

    • index
    • Type:number
    • The zero-based index of the row to get.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException index is less than zero or index is greater than or equal to HiddenRowCollection.count.
  • remove

    .remove( row:ig.excel.WorksheetRow );
    Return Type:
    boolean
    Return Type Description:
    True if the row existed in the collection and was removed; False otherwise or if the specified row is null.

    Removes the specified row from the collection if it exists.

    • row
    • Type:ig.excel.WorksheetRow
    • The row to removed from the collection.
  • removeAt

    .removeAt( index:number );

    Removes the row at the specified index in the collection.

    • index
    • Type:number
    • The zero-based index of the row in the collection.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException index is less than zero or index is greater than or equal to HiddenRowCollection.count.
  • worksheet

    .worksheet( );
    Return Type:
    ig.excel.Worksheet
    Return Type Description:
    The worksheet associated with this collection.

    Gets the worksheet associated with this collection.

Copyright © 1996 - 2019 Infragistics, Inc. All rights reserved.

#