ig.excel.DisplayValueCollection
A collection of display text values.
Dependencies
jquery-1.4.4.js
infragistics.util.js
The current widget has no options.
The current widget has no events.
-
add
- .add( item:string );
Adds a display text value to the collection.
- item
- Type:string
- The display text value to add to the collection.
Exceptions
Exception Description ig.ArgumentNullException item is null or empty. ig.ArgumentException item matches another value in the collection. Values are compared case-insensitively. -
clear
- .clear( );
Clears the collection.
Exceptions
Exception Description ig.InvalidOperationException The collection is owned by a FixedValuesFilter which only allowed the values in the collection. Clearing the collection would prevent the filter from including any values, which is not allowed for a FixedValuesFilter. -
contains
- .contains( item:string );
- Return Type:
- boolean
Determines whether the specified value is in the collection.
- item
- Type:string
- The display text value to find in the collection.
Remarks
Display text values are compared case-insensitively.
-
count
- .count( );
Gets the number of display text values in the collection.
-
indexOf
- .indexOf( item:string );
- Return Type:
- number
- Return Type Description:
- The 0-based index of the specified display text value in the collection or -1 if the item is not in the collection.
Gets the index of the specified display text value in the collection.
- item
- Type:string
- The display text value to find in the collection.
-
insert
- .insert( index:number, item:string );
Inserts a display text value into the collection.
- index
- Type:number
- The 0-based index where the value should be inserted.
- item
- Type:string
- The display text value to insert into the collection.
Exceptions
Exception Description ig.ArgumentNullException item is null or empty. ig.ArgumentException item matches another value in the collection. Values are compared case-insensitively. ig.ArgumentOutOfRangeException index is less than 0 or greater than DisplayValueCollection.count. -
item
- .item( index:number );
Gets the display text value at the specified index.
- index
- Type:number
- The 0-based index of the value to get or set.
Exceptions
Exception Description ig.ArgumentOutOfRangeException index is less than 0 or greater than or equal to DisplayValueCollection.count. ig.ArgumentNullException The value assigned is null. ig.ArgumentException The value assigned matches another value in the collection. Values are compared case-insensitively. -
item
- .item( index:number, value:string );
Sets the display text value at the specified index.
- index
- Type:number
- The 0-based index of the value to get or set.
- value
- Type:string
Exceptions
Exception Description ig.ArgumentOutOfRangeException index is less than 0 or greater than or equal to DisplayValueCollection.count. ig.ArgumentNullException The value assigned is null. ig.ArgumentException The value assigned matches another value in the collection. Values are compared case-insensitively. -
remove
- .remove( item:string );
- Return Type:
- boolean
- Return Type Description:
- True if the value was found and removed; False otherwise.
Removes a display text value from the collection.
- item
- Type:string
- The display text value to remove from the collection.
Remarks
Display text values are compared case-insensitively.
-
removeAt
- .removeAt( index:number );
Removes the display text value at the specified index.
- index
- Type:number
- The 0-based index of the value to remove.
Exceptions
Exception Description ig.ArgumentOutOfRangeException index is less than 0 or greater than or equal to DisplayValueCollection.count. ig.InvalidOperationException This operation removes the last item in the collection and it is owned by a FixedValuesFilter which only allowed the values in the collection. Clearing the collection would prevent the filter from including any values, which is not allowed for a FixedValuesFilter.