ig.excel.CustomViewCollection
A collection of CustomView instances in a workbook.
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.
-
add
- .add( name:string, savePrintOptions:boolean, saveHiddenRowsAndColumns:boolean );
- Return Type:
- ig.excel.CustomView
- Return Type Description:
- The newly created CustomView instance.
Adds a new custom view to the collection.
- name
- Type:string
- The name to give the newly created custom view.
- savePrintOptions
- Type:boolean
- True to save print options for each worksheet with the custom view; False otherwise.
- saveHiddenRowsAndColumns
- Type:boolean
- True to save information about hidden rows and columns for each worksheet with the custom view; False otherwise.
Exceptions
Exception Description ig.ArgumentNullException name is a null or empty. ig.ArgumentException name is the name of another custom view in the collection (custom view names are compared case-insensitively). -
clear
- .clear( );
Clears all custom views from the collection.
-
contains
- .contains( customView:ig.excel.CustomView );
- Return Type:
- boolean
- Return Type Description:
- True if the custom view is found; False otherwise.
Determines whether a custom view is in this collection.
- customView
- Type:ig.excel.CustomView
- The custom view to locate in the collection.
-
count
- .count( );
- Return Type:
- number
- Return Type Description:
- The number of custom views in the collection.
Gets the number of custom views in the collection.
-
item
- .item( index:number );
- Return Type:
- ig.excel.CustomView
- Return Type Description:
- The custom view at the specified index.
Gets the custom view at the specified index.
- index
- Type:number
- The zero-based index of the custom view to get.
Exceptions
Exception Description ig.ArgumentOutOfRangeException index is less than zero or index is greater than or equal to CustomViewCollection.count. -
remove
- .remove( customView:ig.excel.CustomView );
- Return Type:
- boolean
- Return Type Description:
- True if the custom view was successfully removed; False if the custom view was not in the collection.
Removes the specified custom view from the collection.
- customView
- Type:ig.excel.CustomView
- The custom view to remove from the collection.
-
removeAt
- .removeAt( index:number );
Removes the custom view at the specified index from the collection.
- index
- Type:number
- The zero-based index of the custom view in the collection.
Exceptions
Exception Description ig.ArgumentOutOfRangeException index is less than zero or index is greater than or equal to CustomViewCollection.count.