Workbook::&addWorksheet (Previous) (Next) Workbook::&setTempDir
View this page in Last updated: Sun, 01 Jul 2007
English | Dutch | French | German | Hungarian | Japanese | Polish | Russian | Spanish | Plain HTML

Workbook::&addFormat

Workbook::&addFormat -- Add a new format to the Excel workbook.

Synopsis

require_once "Spreadsheet/Excel/Writer.php";

object reference Workbook::&addFormat ([array $properties=array()])

Descripción

Add a new format to the Excel workbook. Also, pass any properties to the Format constructor. Valid properties are:

  • Align

  • Bold

  • Bottom

  • Top

  • Left

  • Right

  • Border

  • BorderColor

  • BottomColor

  • TopColor

  • RightColor

  • LeftColor

  • FgColor

  • BgColor

  • Color

  • Pattern

  • Underline

  • TextRotation

  • Size

  • NumFormat

  • Script

Parámetro

  • array $properties - array with properties for initializing the format.

Valor devuelto

object reference - to an Excel Format

Nota

Esta función no puede ser llamada estáticamente.

Ejemplo

Ejemplo 39-1. Using &addFormat()


<?php
require_once "Spreadsheet/Excel/Writer.php";
$workbook = new Spreadsheet_Excel_Writer();
$format =& $workbook->addFormat(array('Size' => 10,
                                      'Align' => 'center',
                                      'Color' => 'white',
                                      'Pattern' => 1,
                                      'FgColor' => 'magenta'));
$worksheet =& $workbook->addWorksheet();
$worksheet->writeString(1, 0, "Magenta Hello", $format);
$workbook->close();
?>
Workbook::&addWorksheet (Previous) (Next) Workbook::&setTempDir
Download Documentation Last updated: Sun, 01 Jul 2007
Do you think that something on this page is wrong? Please file a bug report or add a note.
User Notes:
Note by: alex@angelov.co.uk
2008-01-10 12:19 UTC
You can also set the 'locked' format property using &addFormat(). This can be done in the same way like 'bold' by assigning to 'locked' a value of 1.
$format =& $workbook->addFormat(array('locked' => 1));
Note by: Elliott Brueggeman
2007-06-14 19:19 UTC
Properties that don't have obvious arguments, such as bold and underline, require a value of 1 in the array to make them function properly.

Example:

(to make a format bold and underlined)

$myFormat=&$workbook->addFormat(
array('bold'=>1,
'underline'=>1 ));