ig.excel.WorksheetColumnCollection

A collection of columns in a worksheet.

Remarks

Columns in this collection are lazily created (they are only created and added to the collection when they are accessed). Therefore, if this collection is enumerated, it only enumerates the columns which were already accessed.

Dependencies

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

  • insert

    .insert( index:number, [count:number] );

    Inserts one or more columns into the collection

    • index
    • Type:number
    • the insertion point
    • count
    • Type:number
    • Optional
    • The number of columns to insert

    Exceptions

    Exception Description
    ig.InvalidOperationException If the operation is not allowed, e.g. if it would cause data to be shifted off the worksheet.
    ig.IndexOutOfRangeException If index is negative.
    ig.ArgumentOutOfRangeException If count is less than 1.

    Remarks

    Note: An equal number of columns will be removed (i.e. bumped) off the end of 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.
    ig.InvalidOperationException index is greater than or equal to Workbook.maxExcelColumnCount or Workbook.maxExcel2007ColumnCount, depending on the Workbook.currentFormat.

    Remarks

    Note: Iterating the collection will not create all columns. It will only iterate the columns which have already been used. To create and iterate all columns in the worksheet use a For loop, iterating from 0 to one less than the maximum column count, and pass in each index to the collection's indexer.

  • maxCount

    .maxCount( );

    Gets the maximum number of items allowed in this collection.

  • remove

    .remove( index:number, [count:number] );

    Removes one or more columns from the collection

    • index
    • Type:number
    • the index of the first column to remove point
    • count
    • Type:number
    • Optional
    • The number of columns to remove

    Exceptions

    Exception Description
    ig.InvalidOperationException If the operation is not allowed, e.g. if it the range intersects with a protected region.
    ig.IndexOutOfRangeException If index is negative.
    ig.ArgumentOutOfRangeException If count is less than 1.

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