previousWorkbook::close (Previous) (Next) Workbook::&addFormatnext

View this page in Last updated: Sun, 18 Oct 2009
English | Brazilian Portuguese | Chinese | Dutch | French | German | Hungarian | Japanese | Polish | Russian | Spanish | Turkish

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 Sheeti 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

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();
?>
previousWorkbook::close (Previous) (Next) Workbook::&addFormatnext

Download Documentation Last updated: Sun, 18 Oct 2009
Do you think that something on this page is wrong? Please file a bug report or add a note.
User Notes:
Note by: srfotograf@web.de
you also can not name a sheet in excel with a slash in it... so it is not a bug...
Note by: Kiezpro
Seems like the worksheet name can't contain a slash ... at least I got a "File Corrupt" message from Excel when I tried to open a generated Excel file containing a worksheet with a slash in it's name. My version of Spreadsheet_Excel_Writer is 0.91.