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

See

Hierarchy

Hierarchy

  • Base
    • CustomTableStyleCollection

Implements

Constructors

Properties

$type: Type
$t: Type
nextHashCode: number

Accessors

  • get count(): number
  • Gets the number of custom WorksheetTableStyle instances in the collection.

    Returns number

Methods

  • Adds a custom WorksheetTableStyle to the collection.

    Throws

    ArgumentNullException 'style' is null.

    Throws

    ArgumentException 'style' is a standard table style.

    Throws

    ArgumentException 'style' is already in a CustomTableStyleCollection.

    Throws

    ArgumentException 'style' has a name which matches one of the other custom table styles in the collection. Names are compared case-insensitively.

    See

    Parameters

    Returns void

  • Clears the collection.

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

    Returns void

  • Determines whether the specified WorksheetTableStyle is contained in the collection.

    Returns

    True if the style is in the collection; False otherwise.

    Parameters

    Returns boolean

  • Parameters

    • other: any

    Returns boolean

  • Returns number

  • Gets the index of the specified style in the collection.

    Throws

    ArgumentNullException 'style' is null.

    Returns

    The 0-based index of the specified style in the collection or -1 if the style is not in the collection.

    Parameters

    Returns number

  • Gets the WorksheetTableStyle at the specified index.

    Throws

    ArgumentOutOfRangeException 'index' is less than 0 or greater than or equal to count.

    Returns

    The WorksheetTableStyle instance at the specified index.

    Parameters

    • index: number

      The index at which to get the WorksheetTableStyle.

    Returns WorksheetTableStyle

  • Gets the WorksheetTableStyle with the specified name.

    Table style names are compared case-insensitively.

    Returns

    The WorksheetTableStyle instance with the specified name or null if a table style with that name does not exist.

    Parameters

    • name: string

      The name of the WorksheetTableStyle to find.

    Returns WorksheetTableStyle

  • Removes the specified WorksheetTableStyle from the collection.

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

    Throws

    ArgumentNullException 'style' is null.

    Returns

    True if the style was in the collection and therefore removed; False otherwise.

    Parameters

    Returns boolean

  • Removes the WorksheetTableStyle at the specified index.

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

    Throws

    ArgumentOutOfRangeException 'index' is less than 0 or greater than or equal to count.

    Parameters

    • index: number

      The index of the table style to remove.

    Returns void

  • Parameters

    • item1: any
    • item2: any

    Returns number

  • Parameters

    • item1: any
    • item2: any

    Returns number

  • Parameters

    • item1: any
    • item2: any

    Returns boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean

  • Parameters

    • obj: any

    Returns any[]

  • Parameters

    • obj: any

    Returns any[]

  • Parameters

    • obj: any

    Returns number

  • Parameters

    • a: any
    • b: any

    Returns boolean

  • Returns void