PEAR Manual
Prev |  | Next

# Workbook::&addWorksheet

Workbook::&addWorksheet -- Add a new worksheet to the Excel workbook.

## Synopsis

    require_once "Spreadsheet/Excel/Writer.php";

``object reference Workbook::&addWorksheet` ([string $name=''])`

## Description

Add a new worksheet to the Excel workbook. If no name is given the name of the worksheet will be Sheet`i` with `i` in [1..].

## Parameter

- `string $name` - the optional name of the worksheet. Can not be longer than 31 characters.

## Return value

returns a reference to a worksheet object on success, PEAR_Error on failure

## Note

This function can not be called statically.

## Example

Example 37-1. Using &addWorksheet()
    <?php
    require_once 'Spreadsheet/Excel/Writer.php';
    $workbook = new Spreadsheet_Excel_Writer('test.xls');
    $worksheet =& $workbook->addWorksheet('My first worksheet');
    if (PEAR::isError($worksheet)) {
        die($worksheet->getMessage());
    }
    $workbook->close();
    ?>

Prev | Home | Next
Workbook::close | Up | Workbook::&addFormat