Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class WorkbookStyle

Represents a complex format which can be applied to a cell's format.

When a style is applied to a cell by setting its CellFormat.Style property, the cell's format will pick up subsequent changes to the format properties set by the style when it was applied. This will continue to happen until those format properties are set to other values on the cell format.

See

  • [[IWorksheetCellFormat.style]]
  • [[Workbook.styles]]

Hierarchy

Hierarchy

  • Base
    • WorkbookStyle

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

$type

$type: Type

Static $t

$t: Type

Static nextHashCode

nextHashCode: number

Accessors

Abstract isBuiltIn

  • get isBuiltIn(): boolean

  • Gets the value indicating whether the style is a built in style in Microsoft Excel.

    Returns boolean

Abstract name

  • get name(): string

  • Gets or sets the name of the workbook style.

    The style names must be case-insensitively unique and the names for built in styles cannot be changed.

    The name of the workbook style.

    Throws

    [[InvalidOperationException]] The value is assigned and the style is a built.

    Throws

    [[ArgumentException]] The value assigned is null or empty.

    Throws

    [[ArgumentException]] The value assigned is longer than 255 characters.

    Throws

    [[ArgumentException]] The value assigned matches the name of another style in the collection.

    See

    [[isBuiltIn]]

    Returns string

  • set name(a): void

  • Parameters

    • a: string

    Returns void

styleFormat

  • get styleFormat(): IWorksheetCellFormat

  • Gets the cell format which applies to the workbook style. The cell format which applies to the workbook style.

    Returns IWorksheetCellFormat

Methods

equals

  • equals(other): boolean

  • Parameters

    • other: any

    Returns boolean

getHashCode

  • getHashCode(): number

  • Returns number

memberwiseClone

  • memberwiseClone(): Base

  • Returns Base

Abstract reset

  • reset(): void

  • Resets the style to its original state.

    If this is a user defined style, the format of the style will be reset so that it provides no formatting properties. If this is a built in style, this format will revert back to its preset state if it has previously been changed.

    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