ig.excel.WorksheetCollection

A collection of worksheets 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 );
    Return Type:
    ig.excel.Worksheet
    Return Type Description:
    The Worksheet created with the specified name.

    Creates a new Worksheet and adds it to the collection.

    • name
    • Type:string
    • The name to give the new Worksheet.

    Exceptions

    Exception Description
    ig.ArgumentNullException name is null or empty.
    ig.ArgumentException name contains the invalid characters: ':', '\', '/', '?', '*', '[', or ']'.
    ig.ArgumentException name exceeds 31 characters in length.
    ig.ArgumentException name is being used as the name of another worksheet (worksheet names are case-insensitively compared).

    Remarks

    If the workbook originally had no worksheets, the newly added worksheet will become the selected worksheet of the workbook. This can be changed after more worksheets are added by setting the WindowOptions.selectedWorksheet of the Workbook.

  • clear

    .clear( );

    Clears all worksheets from the collection.

    Remarks

    If there are any NamedReference instances in the Workbook.namedReferences collection with a worksheet for a scope, they will be removed from the Workbook.

  • contains

    .contains( worksheet:ig.excel.Worksheet );
    Return Type:
    boolean
    Return Type Description:
    True if the worksheet is found; False otherwise.

    Determines whether a worksheet is in the collection.

    • worksheet
    • Type:ig.excel.Worksheet
    • The worksheet to locate in the collection.
  • count

    .count( );
    Return Type:
    number
    Return Type Description:
    The number of worksheets in the collection.

    Gets the number of worksheets in the collection.

  • exists

    .exists( name:string );
    Return Type:
    boolean
    Return Type Description:
    True if a worksheet with the specified name is found; False otherwise.

    Determines whether a worksheet with the specified name exists in the collection.

    • name
    • Type:string
    • The name of the worksheet to search for. The name is compared case-insensitively.
  • indexOf

    .indexOf( worksheet:ig.excel.Worksheet );
    Return Type:
    number
    Return Type Description:
    The index of the specified worksheet in the collection.

    Gets the index of the specified worksheet in the collection.

    • worksheet
    • Type:ig.excel.Worksheet
    • The worksheet of which to get the index.
  • item

    .item( index:number );
    Return Type:
    ig.excel.Worksheet
    Return Type Description:
    The worksheet at the specified index.

    Gets the worksheet at the specified index.

    • index
    • Type:number
    • The zero-based index of the worksheet to get.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException index is less than zero or index is greater than or equal to WorksheetCollection.count.
  • item

    .item( name:string );
    Return Type:
    ig.excel.Worksheet
    Return Type Description:
    The worksheet with the specified name.

    Gets the worksheet with the specified name.

    • name
    • Type:string
    • The name of the worksheet to get.

    Exceptions

    Exception Description
    ig.InvalidOperationException A worksheet with the specified name does not exist in the collection.

    Remarks

    Worksheet names are compared case-insensitively.

  • remove

    .remove( worksheet:ig.excel.Worksheet );
    Return Type:
    boolean
    Return Type Description:
    True if the worksheet was successfully removed from the collection; False if the worksheet did not exist in the collection.

    Removes the specified worksheet from the collection.

    • worksheet
    • Type:ig.excel.Worksheet
    • The worksheet to remove from the collection.

    Remarks

    If there are any NamedReference instances in the Workbook.namedReferences collection with the worksheet to remove as their scope, they will be removed from the Workbook.

  • removeAt

    .removeAt( index:number );

    Removes the worksheet at the specified index from the collection.

    • index
    • Type:number
    • The index of the worksheet to remove from the collection.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException index is less than zero or index is greater than or equal to WorksheetCollection.count.

    Remarks

    If there are any NamedReference instances in the Workbook.namedReferences collection with the worksheet to remove as their scope, they will be removed from the Workbook.

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