ig.excel.WorksheetRowCollection
A collection of rows in a worksheet.
Remarks
Rows in this collection are lazily created (they are only created and added to the collection when they are accessed). If this collection is enumerated, it only enumerates the rows which were already accessed.
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.
-
insert
- .insert( index:number, [count:number] );
Inserts one or more rows into the collection
- index
- Type:number
- the insertion point
- count
- Type:number
- Optional
- The number of rows 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 rows will be removed (i.e. bumped) off the end of 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. ig.InvalidOperationException index is greater than or equal to Workbook.maxExcelRowCount or Workbook.maxExcel2007RowCount, depending on the Workbook.currentFormat. Remarks
Note: Iterating the collection will not create all rows. It will only iterate the rows which have already been used. To create and iterate all rows in the worksheet use a For loop, iterating from 0 to one less than the maximum row count, and pass in each index to the collection's indexer.
See Also
-
maxCount
- .maxCount( );
Gets the maximum number of items allowed in this collection.
-
remove
- .remove( index:number, [count:number] );
Removes one or more rows from the collection
- index
- Type:number
- the index of the first row to remove point
- count
- Type:number
- Optional
- The number of rows 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.