PEAR Manual
Prev |  | Next

# Format::setUnderline

Format::setUnderline -- Sets the underline of the text

## Synopsis

    require_once "Spreadsheet/Excel/Writer.php";

``void Format::setUnderline` (integer $underline)`

## Description

Sets the underline of the text

## Parameter

- `integer $underline` - The value for underline. Possible values are 1 => underline, 2 => double underline.

## Note

This function can not be called statically.

## Example

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

      $workbook = new Spreadsheet_Excel_Writer();
      $format_underline =& $workbook->addFormat();
      $format_underline->setUnderline(1);
      $worksheet =& $workbook->addWorksheet();
      $worksheet->write(0, 0, "This is underlined", $format_underline);
      $format_underline->setUnderline(2);
      $worksheet->write(1, 0, "This is twice underlined", $format_underline);

Prev | Home | Next
Format::setPattern | Up | Format::setItalic