Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class CustomTableStyleCollection

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

See

  • [[Workbook.defaultTableStyle]]
  • [[Workbook.customTableStyles]]

Hierarchy

Hierarchy

  • Base
    • CustomTableStyleCollection

Implements

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

$type

$type: Type

Static $t

$t: Type

Static nextHashCode

nextHashCode: number

Accessors

count

  • get count(): number

  • Gets the number of custom [[WorksheetTableStyle]] instances in the collection.

    Returns number

Methods

[iterator]

add

  • add(style): void

  • 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

    • [[WorksheetTableStyle.isCustom]]
    • [[WorksheetTableStyle.name]]

    Parameters

    Returns void

clear

  • clear(): 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

contains

  • contains(style): boolean

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

    Parameters

    Returns boolean

equals

  • equals(other): boolean

  • Parameters

    • other: any

    Returns boolean

getHashCode

  • getHashCode(): number

  • Returns number

indexOf

  • indexOf(style): number

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

    Throws

    [[ArgumentNullException]] 'style' is null.

    Parameters

    Returns number

item

  • item(index): WorksheetTableStyle

  • Gets the [[WorksheetTableStyle]] at the specified index.

    Throws

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

    Parameters

    • index: number

      The index at which to get the WorksheetTableStyle.

    Returns WorksheetTableStyle

  • item(name): WorksheetTableStyle

  • Gets the [[WorksheetTableStyle]] with the specified name.

    Table style names are compared case-insensitively.

    Parameters

    • name: string

      The name of the WorksheetTableStyle to find.

    Returns WorksheetTableStyle

memberwiseClone

  • memberwiseClone(): Base

  • Returns Base

remove

  • remove(style): boolean

  • 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.

    Parameters

    Returns boolean

removeAt

  • removeAt(index): void

  • 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

Static compare

  • compare(item1, item2): number

  • Parameters

    • item1: any
    • item2: any

    Returns number

Static compareSimple

  • compareSimple(item1, item2): number

  • Parameters

    • item1: any
    • item2: any

    Returns number

Static equalsSimple

  • equalsSimple(item1, item2): boolean

  • Parameters

    • item1: any
    • item2: any

    Returns boolean

Static equalsStatic

  • equalsStatic(a, b): boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static getArrayOfProperties

  • getArrayOfProperties(obj): any[]

  • Parameters

    • obj: any

    Returns any[]

Static getArrayOfValues

  • getArrayOfValues(obj): any[]

  • Parameters

    • obj: any

    Returns any[]

Static getHashCodeStatic

  • getHashCodeStatic(obj): number

  • Parameters

    • obj: any

    Returns number

Static referenceEquals

  • referenceEquals(a, b): boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static staticInit

  • staticInit(): void

  • Returns void