constructor

• new WorkbookStyleCollection(a): WorkbookStyleCollection

• Parameters

  • a: Workbook

  Returns WorkbookStyleCollection

Static $t

count

• get count(): number

• Gets the number of styles in the collection. The number of styles in the collection.

  Returns number

normalStyle

• get normalStyle(): WorkbookStyle

• Gets the default style for the workbook.

  The normal style is the parent style for all cell and differential formats in the workbook, unless another parent style is specified.

  See

  [[IWorksheetCellFormat.style]]

  Returns WorkbookStyle

[iterator]

• [iterator](): EnumeratorWrapper<WorkbookStyle>

• Returns EnumeratorWrapper<WorkbookStyle>

_u

• _u(): IEnumerable$1<WorkbookBuiltInStyle>

• Returns IEnumerable$1<WorkbookBuiltInStyle>

addUserDefinedStyle

• addUserDefinedStyle(styleFormat, name): WorkbookStyle

• Adds new user defined style to the workbook.

  Throws

  [[ArgumentNullException]] 'name' is null or empty.

  Throws

  [[ArgumentNullException]] 'name' is longer than 255 characters.

  Throws

  [[ArgumentException]] A style already exists with the a name of 'name'. Names are compared case-insensitively.

  Parameters

  • styleFormat: IWorksheetCellFormat

    A cell format of the style.

  • name: string

    The name which will identify the style in Microsoft Excel.

  Returns WorkbookStyle

• addUserDefinedStyle(name): WorkbookStyle

• Adds new user defined style to the workbook.

  Throws

  [[ArgumentNullException]] 'name' is null or empty.

  Throws

  [[ArgumentNullException]] 'name' is longer than 255 characters.

  Throws

  [[ArgumentException]] A style already exists with the a name of 'name'. Names are compared case-insensitively.

  Parameters

  • name: string

    The name which will identify the style in Microsoft Excel.

  Returns WorkbookStyle

clear

• clear(): void

• Clears all styles, other than the Normal style, from the collection.

  See

  [[normalStyle]]

  Returns void

contains

• contains(style): boolean

• Determines whether a style is in the collection.

  Parameters

  • style: WorkbookStyle

    The style to locate in the collection.

  Returns boolean

item

• item(index): WorkbookStyle

• Gets the style at the specified index. The style at the specified index.

  Throws

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

  Parameters

  • index: number

    The zero-based index of the style to get.

  Returns WorkbookStyle

• item(name): WorkbookStyle

• Gets the style with the specified name.

  Style names are compared case-insensitively.

  The style with the specified name or null if no style with that name exists.

  Throws

  [[ArgumentNullException]] 'name' is null.

  Parameters

  • name: string

    The name of the style to get.

  Returns WorkbookStyle

remove

• remove(style): boolean

• Removes the specified style from the collection.

  Throws

  [[InvalidOperationException]] 'style' is the Normal style.

  See

  [[normalStyle]]

  Parameters

  • style: WorkbookStyle

    The style to remove from the collection.

  Returns boolean

removeAt

• removeAt(index): void

• Removes the style at the specified index from the collection.

  Throws

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

  Throws

  [[InvalidOperationException]] The style to remove at 'index' is the Normal style.

  See

  [[normalStyle]]

  Parameters

  • index: number

    The zero-based index of the style in the collection.

  Returns void

reset

• reset(): void

• Resets the collection to its original state by clearing all styles and adding in preset built in styles.

  Returns void

Static staticInit

• staticInit(): void

• Returns void