ig.excel.WorksheetTableColumnCollection

A read-only collection of all WorksheetTableColumn instances which exist in a WorksheetTable.

Dependencies

jquery-1.4.4.js
infragistics.util.js
infragistics.ext_core.js
infragistics.ext_collections.js
infragistics.ext_collectionsExtended.js
infragistics.ext_io.js
infragistics.ext_text.js
infragistics.documents.core_core.js
infragistics.ext_ui.js
The current widget has no options.
The current widget has no events.
  • contains

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

    Determines whether the specified WorksheetTableColumn is in the collection.

    • column
    • Type:ig.excel.WorksheetTableColumn
    • The column to find in the collection.
  • count

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

    Gets the number of WorksheetTableColumn instances in the collection.

  • indexOf

    .indexOf( column:ig.excel.WorksheetTableColumn );
    Return Type:
    number
    Return Type Description:
    The 0-based index of the specified WorksheetTableColumn in the collection or -1 if the item is not in the collection.

    Gets the index of the specified WorksheetTableColumn in the collection.

    • column
    • Type:ig.excel.WorksheetTableColumn
    • The WorksheetTableColumn to find in the collection.
  • item

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

    Gets the WorksheetTableColumn at the specified index.

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

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException index is less than 0 or greater than or equal to the number of columns in the collection.
  • item

    .item( name:string );
    Return Type:
    ig.excel.WorksheetTableColumn
    Return Type Description:
    The WorksheetTableColumn with the specified name or null a column with the specified name doesn't exist.

    Gets the WorksheetTableColumn with the specified name or null if it doesn't exist.

    • name
    • Type:string
    • The name of the column to get.

    Remarks

    Column names are compared case-insensitively.

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