ig.excel.HiddenColumnCollection

A collection of hidden WorksheetColumn instances.

Remarks

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

Dependencies

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

  • add

    .add( column:ig.excel.WorksheetColumn );

    Adds a column to the collection.

    • column
    • Type:ig.excel.WorksheetColumn
    • The column to be added to the hidden columns collection.

    Exceptions

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

    Remarks

    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.

  • clear

    .clear( );

    Clears all columns from the collection.

  • contains

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

    Determines whether the specified column exists in the collection.

    • column
    • Type:ig.excel.WorksheetColumn
    • The column to search for in the collection.

  • count

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

    Gets the number of columns in the collection.

  • item

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

    Gets the column at the specified index.

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

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException index is less than zero or index is greater than or equal to HiddenColumnCollection.count.

  • remove

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

    Removes the specified column from the collection if it exists.

    • column
    • Type:ig.excel.WorksheetColumn
    • The column to removed from the collection.

  • removeAt

    .removeAt( index:number );

    Removes the column at the specified index in the collection.

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

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException index is less than zero or index is greater than or equal to HiddenColumnCollection.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 - 2024 Infragistics, Inc. All rights reserved.