ig.excel.CustomTableStyleCollection

A collection of custom WorksheetTableStyle instances which can be applied to a WorksheetTable in the CustomTableStyleCollection.workbook.

Dependencies

jquery-1.4.4.js
infragistics.util.js
infragistics.ext_collections.js
infragistics.ext_collectionsExtended.js
infragistics.ext_io.js
infragistics.ext_text.js
infragistics.ext_core.js
infragistics.documents.core_core.js
infragistics.ext_ui.js
The current widget has no options.
The current widget has no events.
  • add

    .add( style:ig.excel.WorksheetTableStyle );

    Adds a custom WorksheetTableStyle to the collection.

    • style
    • Type:ig.excel.WorksheetTableStyle
    • The custom table style to add to the collection.

    Exceptions

    Exception Description
    ig.ArgumentNullException style is null.
    ig.ArgumentException style is a standard table style.
    ig.ArgumentException style is already in a CustomTableStyleCollection.
    ig.ArgumentException style has a name which matches one of the other custom table styles in the collection. Names are compared case-insensitively.
  • clear

    .clear( );

    Clears the collection.

    Remarks

    If any WorksheetTable instances in the workbook have their style removed due to this operation, their style will be set to the Workbook.defaultTableStyle.

  • contains

    .contains( style:ig.excel.WorksheetTableStyle );
    Return Type:
    boolean
    Return Type Description:
    True if the style is in the collection; False otherwise.

    Determines whether the specified WorksheetTableStyle is contained in the collection.

    • style
    • Type:ig.excel.WorksheetTableStyle
    • The table style to find in the collection.
  • count

    .count( );

    Gets the number of custom WorksheetTableStyle instances in the collection.

  • indexOf

    .indexOf( style:ig.excel.WorksheetTableStyle );
    Return Type:
    number
    Return Type Description:
    The 0-based index of the specified style in the collection or -1 if the style is not in the collection.

    Gets the index of the specified style in the collection.

    • style
    • Type:ig.excel.WorksheetTableStyle
    • The style to find in the collection.

    Exceptions

    Exception Description
    ig.ArgumentNullException style is null.
  • item

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

    Gets the WorksheetTableStyle at the specified index.

    • index
    • Type:number
    • The index at which to get the WorksheetTableStyle.

    Exceptions

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

    .item( name:string );
    Return Type:
    ig.excel.WorksheetTableStyle
    Return Type Description:
    The WorksheetTableStyle instance with the specified name or null if a table style with that name does not exist.

    Gets the WorksheetTableStyle with the specified name.

    • name
    • Type:string
    • The name of the WorksheetTableStyle to find.

    Remarks

    Table style names are compared case-insensitively.

  • remove

    .remove( style:ig.excel.WorksheetTableStyle );
    Return Type:
    boolean
    Return Type Description:
    True if the style was in the collection and therefore removed; False otherwise.

    Removes the specified WorksheetTableStyle from the collection.

    • style
    • Type:ig.excel.WorksheetTableStyle
    • The table style to remove from the collection.

    Exceptions

    Exception Description
    ig.ArgumentNullException style is null.

    Remarks

    If any WorksheetTable instances in the workbook have their style removed due to this operation, their style will be set to the Workbook.defaultTableStyle.

  • removeAt

    .removeAt( index:number );

    Removes the WorksheetTableStyle at the specified index.

    • index
    • Type:number
    • The index of the table style to remove.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException index is less than 0 or greater than or equal to CustomTableStyleCollection.count.

    Remarks

    If any WorksheetTable instances in the workbook have their style removed due to this operation, their style will be set to the Workbook.defaultTableStyle.

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