constructor

• new WorksheetTableStyle(name): WorksheetTableStyle

• Parameters

  • name: string

  Returns WorksheetTableStyle

• new WorksheetTableStyle(name, isCustom): WorksheetTableStyle

• Parameters

  • name: string

  • isCustom: boolean

  Returns WorksheetTableStyle

• new WorksheetTableStyle(..._rest): WorksheetTableStyle

• Parameters

  • Rest ..._rest: any[]

  Returns WorksheetTableStyle

Static $t

alternateColumnStripeWidth

• get alternateColumnStripeWidth(): number

• Gets or sets the number of columns which will span each alternate column stripe.

  The stripe sizes must be between 1 and 9, inclusive.

  The column stripes are assigned from left to right in the table, first assigning the column stripe, then the alternate column stripe, then repeating.

  The alternate column stripe format is defined in the [[areaFormats]] collection and keyed by the [[WorksheetTableStyleArea]].AlternateColumnStripe value.

  The number of columns which will span each alternate column stripe.

  Throws

  [[InvalidOperationException]] The value is set and [[isCustom]] is False, indicating that the style is a read-only, standard table style.

  Throws

  [[ArgumentOutOfRangeException]] The value assigned is less than 1 or greater than 9.

  See

  [[columnStripeWidth]]

  Returns number

• set alternateColumnStripeWidth(a): void

• Parameters

  • a: number

  Returns void

alternateRowStripeHeight

• get alternateRowStripeHeight(): number

• Gets or sets the number of rows which will span each alternate row stripe.

  The stripe sizes must be between 1 and 9, inclusive.

  The row stripes are assigned from top to bottom in the table, first assigning the row stripe, then the alternate row stripe, then repeating.

  The alternate row stripe format is defined in the [[areaFormats]] collection and keyed by the [[WorksheetTableStyleArea]].AlternateRowStripe value.

  The number of rows which will span each alternate row stripe.

  Throws

  [[InvalidOperationException]] The value is set and [[isCustom]] is False, indicating that the style is a read-only, standard table style.

  Throws

  [[ArgumentOutOfRangeException]] The value assigned is less than 1 or greater than 9.

  See

  [[rowStripeHeight]]

  Returns number

• set alternateRowStripeHeight(a): void

• Parameters

  • a: number

  Returns void

columnStripeWidth

• get columnStripeWidth(): number

• Gets or sets the number of columns which will span each column stripe.

  The stripe sizes must be between 1 and 9, inclusive.

  The column stripes are assigned from left to right in the table, first assigning the column stripe, then the alternate column stripe, then repeating.

  The column stripe format is defined in the [[areaFormats]] collection and keyed by the [[WorksheetTableStyleArea]].ColumnStripe value.

  The number of columns which will span each column stripe.

  Throws

  [[InvalidOperationException]] The value is set and [[isCustom]] is False, indicating that the style is a read-only, standard table style.

  Throws

  [[ArgumentOutOfRangeException]] The value assigned is less than 1 or greater than 9.

  See

  [[alternateColumnStripeWidth]]

  Returns number

• set columnStripeWidth(a): void

• Parameters

  • a: number

  Returns void

isCustom

• get isCustom(): boolean

• Gets the value indicating whether the style is a custom style. True id this is a custom table style; False if this is a read-only, standard table style.

  Returns boolean

name

• get name(): string

• Gets or sets the name of the style. The name of the style.

  Throws

  [[InvalidOperationException]] The value is set and [[isCustom]] is False, indicating that the style is a read-only, standard table style.

  Throws

  [[ArgumentException]] The value assigned is null, empty, or greater than 255 characters in length.

  Throws

  [[ArgumentException]] The value assigned matches the name of another custom style in the owning [[Workbook.customTableStyles]] collection. Table names are compared case-insensitively.

  Returns string

• set name(a): void

• Parameters

  • a: string

  Returns void

rowStripeHeight

• get rowStripeHeight(): number

• Gets or sets the number of rows which will span each row stripe.

  The stripe sizes must be between 1 and 9, inclusive.

  The row stripes are assigned from top to bottom in the table, first assigning the row stripe, then the alternate row stripe, then repeating.

  The row stripe format is defined in the [[areaFormats]] collection and keyed by the [[WorksheetTableStyleArea]].RowStripe value.

  The number of rows which will span each row stripe.

  Throws

  [[InvalidOperationException]] The value is set and [[isCustom]] is False, indicating that the style is a read-only, standard table style.

  Throws

  [[ArgumentOutOfRangeException]] The value assigned is less than 1 or greater than 9.

  See

  [[alternateRowStripeHeight]]

  Returns number

• set rowStripeHeight(a): void

• Parameters

  • a: number

  Returns void

areaFormats

• areaFormats(area): IWorksheetCellFormat

• Gets the format for the specified area. An [[IWorksheetCellFormat]] instance describing the appearance of the specified area.

  Throws

  [[InvalidEnumArgumentException]] 'area' is not defined.

  Parameters

  • area: WorksheetTableStyleArea

    The area for which to get the format.

  Returns IWorksheetCellFormat

• areaFormats(): WorksheetTableAreaFormatsCollection$1<WorksheetTableStyleArea>

• Gets the collection of formats used for each area of a [[WorksheetTable]] to which the style is applied.

  The area formats specified are differential formats. In other words, only the properties that are set to non-default values will be applied to the appropriate cells. An area format can define only a background color or only font information and that format will be applied to the cells while all other formatting properties on the cells will be maintained.

  See

  • [[WorksheetTable.areaFormats]]
  • [[WorksheetTableColumn.areaFormats]]

  Returns WorksheetTableAreaFormatsCollection$1<WorksheetTableStyleArea>

clone

• clone(name): WorksheetTableStyle

• Duplicates the style and returns a deep copy.

  A cloned style must be added to the [[Workbook.customTableStyles]] collection before it can be applied to a [[WorksheetTable]].

  The only value not cloned from the style is the [[isCustom]] value. Cloning a standard style creates a custom style with the same style settings which can then be changed.

  Throws

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

  Parameters

  • name: string

    The name to give to the cloned style.

  Returns WorksheetTableStyle