constructor

• new WorkbookColorPalette(a): WorkbookColorPalette

• Parameters

  • a: Workbook

  Returns WorkbookColorPalette

Static $t

count

• get count(): number

• Gets the number of colors in the palette, which is always 56.

  Returns number

isCustom

• get isCustom(): boolean

• Gets the value which indicates whether the palette has been cusotmized.

  See

  [[reset]]

  Returns boolean

[iterator]

• [iterator](): EnumeratorWrapper<Color>

• Returns EnumeratorWrapper<Color>

contains

• contains(color): boolean

• Determines whether the specified color is in the color palette.

  Parameters

  • color: string | Color

    The color to find in the palette.

  Returns boolean

getEnumerator

• getEnumerator(): IEnumerator$1<Color>

• Returns IEnumerator$1<Color>

getIndexOfNearestColor

• getIndexOfNearestColor(color): number

• Gets the index of the closest color in the color palette, which will be seen when the file is opened in Microsoft Excel 2003 and older versions.

  Parameters

  • color: string | Color

    The color to match in the palette.

  Returns number

item

• item(index, value?): string

• Gets or sets a color in the palette.

  When a color is set in the palette, [[isCustom]] will return True. The palette can than be reset with the [[reset]] method.

  Colors added to the palette must be opaque.

  Throws

  [[ArgumentOutOfRangeException]] 'index' is less than 0 or greater than 55.

  Throws

  [[ArgumentException]] The value assigned is an empty color, a system color, or is not opaque.

  See

  • [[isCustom]]
  • [[reset]]

  Parameters

  • index: number

    The index of the color to get or set in the palette.

  • Optional value: string | Color

  Returns string

reset

• reset(): void

• Resets the palette back to the default colors for Microsoft Excel.

  See

  [[isCustom]]

  Returns void