PEAR Manual
Prev |  | Next

# Format::setFgColor

Format::setFgColor -- Sets the cell's foreground color

## Synopsis

    require_once "Spreadsheet/Excel/Writer.php";

``void Format::setFgColor` (mixed $color)`

## Description

Sets the cell's "foreground color".

The term "foreground color" is misleading. Here, "foreground" means the top layer of a cell's background. To set the color of a cell's contents, use the setColor() method.

The color actually seen may depend on the pattern and background color being used.

The example entitled "How background and foreground colors interact with patterns" is very helpful.

## Parameter

- `mixed $color` - either a string (like 'blue'), or an integer (range is [8...63]).

  See the "Using colors" section, below, for more information.

## Using colors

The following colors can be defined by name: `black`, `white`, `red`, `green`, `blue`, `yellow`, `magenta` and `cyan`.

To learn what the other indexed colors look like, read Color Palette and the 56 Excel ColorIndex Colors. Beware that the color indexes listed there are displaced by 1 with respect to those used by Spreadsheet_Excel_Writer.

If the predifined colors don't meet your requirements, use the setCustomColor() method.

## Note

This function can not be called statically.

## Example

Example 37-1. Using setFgColor()
    require_once 'Spreadsheet/Excel/Writer.php';

    $workbook = new Spreadsheet_Excel_Writer();
    $worksheet =& $workbook->addWorksheet();

    // "regular" green
    $format_regular_green =& $workbook->addFormat();
    $format_regular_green->setFgColor('green');

    // "special" green
    $format_special_green =& $workbook->addFormat();
    $format_special_green->setFgColor(11);

    // our green (overwriting color on index 12)
    $workbook->setCustomColor(12, 10, 200, 10);
    $format_our_green =& $workbook->addFormat();
    $format_our_green->setFgColor(12);

    $worksheet->setColumn(0, 0, 30);

    $worksheet->write(0, 0, "Regular green", $format_regular_green);
    $worksheet->write(1, 0, "Special green (index 11)", $format_special_green);
    $worksheet->write(2, 0, "Our green", $format_our_green);

    $workbook->send('setFgColor.xls');
    $workbook->close();

## See

setBgColor(), setPattern(), setColor()

Prev | Home | Next
Format::setRightColor | Up | Format::setBgColor