ig.excel.WorksheetProtectedRangeCollection
A collection of WorksheetProtectedRange instances in a Worksheet
Dependencies
jquery-1.4.4.js
infragistics.util.js
The current widget has no options.
The current widget has no events.
-
add
- .add( item:ig.excel.WorksheetProtectedRange );
Adds the specified range to the collection.
- item
- Type:ig.excel.WorksheetProtectedRange
- The range to be added
-
clear
- .clear( );
Clears all ranges from the collection.
-
contains
- .contains( range:ig.excel.WorksheetProtectedRange );
- Return Type:
- boolean
- Return Type Description:
- True if the range is found; False otherwise.
Determines whether a range is in the collection.
- range
- Type:ig.excel.WorksheetProtectedRange
- The range to locate in the collection.
-
count
- .count( );
Gets the number of ranges in the collection.
-
getEnumerator
- .getEnumerator( );
Gets an enumerator which can iterator all ranges in the collection.
-
insert
- .insert( index:number, range:ig.excel.WorksheetProtectedRange );
Inserts the specified range in the collection.
- index
- Type:number
- The 0-based index in the collection where the range should be inserted.
- range
- Type:ig.excel.WorksheetProtectedRange
- The range to insert in the collection.
-
item
- .item( index:number );
- Return Type:
- ig.excel.WorksheetProtectedRange
- Return Type Description:
- The range at the specified index.
Gets the range at the specified index in the collection.
- index
- Type:number
- The zero-based index of the range to get.
Exceptions
Exception Description ig.ArgumentOutOfRangeException index is less than zero or index is greater than or equal to WorksheetProtectedRangeCollection.count. -
remove
- .remove( range:ig.excel.WorksheetProtectedRange );
- Return Type:
- boolean
- Return Type Description:
- True if the range was successfully removed from the collection; False if the range did not exist in the collection.
Removes the specified range from the collection.
- range
- Type:ig.excel.WorksheetProtectedRange
- The range to remove from the collection.
-
removeAt
- .removeAt( index:number );
Removes the range at the specified index from the collection.
- index
- Type:number
- The index of the range to remove from the collection.
Exceptions
Exception Description ig.ArgumentOutOfRangeException index is less than zero or index is greater than or equal to WorksheetProtectedRangeCollection.count.