This documentation is archived and is not being maintained.

Workbook.Colors Property

Gets or sets colors in the palette for the workbook.

Namespace: Microsoft.Office.Tools.Excel
Assembly: Microsoft.Office.Tools.Excel (in microsoft.office.tools.excel.dll)

public virtual _ColorsType Colors { get; }

Property Value

An RGB color value in the color palette for the workbook, or an array that contains all 56 RGB color values in the color palette for the workbook.

The Colors property can be used with the following parameter.

Parameter

Description

Index

The index number of a color in the workbook color palette (from 1 to 56). If this argument is not specified, this property returns an array that contains all 56 of the colors in the palette.

If you attempt to use Colors without specifying any parameters, Colors will get a Workbook._ColorsType object that is part of the Visual Studio Tools for Office infrastructure and is not intended to be used directly from your code.

The workbook palette has 56 entries, each represented by an RGB value.

Optional Parameters

For information on optional parameters, see Understanding Optional Parameters in COM Interop.

The following code example uses the Colors property to set the first color in the workbook's color palette to blue, and then programmatically displays the Microsoft Office Excel Color Palette dialog to verify that this change was made.

private void SetFirstColorInPalette()
{
    this.Colors[1] = ColorTranslator.ToOle(Color.Blue);

    this.Application.Dialogs[
        Excel.XlBuiltInDialog.xlDialogColorPalette].Show(
        missing, missing, missing, missing, missing, missing,
        missing, missing, missing, missing, missing, missing,
        missing, missing, missing, missing, missing, missing, 
        missing, missing, missing, missing, missing, missing,
        missing, missing, missing, missing, missing, missing);
}

Show: