Spreadsheet_Excel_Writer
[ class tree: Spreadsheet_Excel_Writer ] [ index: Spreadsheet_Excel_Writer ] [ all elements ]

Class: Spreadsheet_Excel_Writer_Workbook

Source Location: /Spreadsheet_Excel_Writer-0.9.3/Spreadsheet/Excel/Writer/Workbook.php

Class Overview

PEAR
   |
   --Spreadsheet_Excel_Writer_BIFFwriter
      |
      --Spreadsheet_Excel_Writer_Workbook

Class for generating Excel Spreadsheets


Author(s):

Methods


Child classes:

Spreadsheet_Excel_Writer
Class for writing Excel Spreadsheets. This class should change COMPLETELY.

Inherited Variables

Inherited Methods


Class Details

[line 50]
Class for generating Excel Spreadsheets


[ Top ]


Method Detail

Spreadsheet_Excel_Writer_Workbook (Constructor)   [line 174]

Spreadsheet_Excel_Writer_Workbook Spreadsheet_Excel_Writer_Workbook( string $filename)

Class constructor
  • Access: public

Parameters:

string   $filename   —  filename for storing the workbook. "-" for writing to stdout.

[ Top ]

addFormat   [line 360]

&Spreadsheet_Excel_Writer_Format &addFormat( [array $properties = array()])

Add a new format to the Excel workbook.

Also, pass any properties to the Format constructor.

  • Return: reference to an Excel Format
  • Access: public

Parameters:

array   $properties   —  array with properties for initializing the format.

[ Top ]

addValidator   [line 374]

&Spreadsheet_Excel_Writer_Validator &addValidator( )

Create new validator.
  • Return: reference to a Validator
  • Access: public

[ Top ]

addWorksheet   [line 310]

mixed &addWorksheet( [string $name = ''])

Add a new worksheet to the Excel workbook.

If no name is given the name of the worksheet will be Sheeti$i, with $i in [1..].

  • Return: reference to a worksheet object on success, PEAR_Error on failure
  • Access: public

Parameters:

string   $name   —  the optional name of the worksheet

[ Top ]

close   [line 213]

mixed close( )

Calls finalization methods.

This method should always be the last one to be called on every workbook

  • Return: true on success. PEAR_Error on failure
  • Access: public

[ Top ]

setCountry   [line 295]

void setCountry( integer $code)

Set the country identifier for the workbook
  • Access: public

Parameters:

integer   $code   —  Is the international calling country code for the chosen country.

[ Top ]

setCustomColor   [line 392]

integer setCustomColor( integer $index, integer $red, integer $green, integer $blue)

Change the RGB components of the elements in the colour palette.
  • Return: The palette index for the custom color
  • Access: public

Parameters:

integer   $index   —  colour index
integer   $red   —  red RGB value [0-255]
integer   $green   —  green RGB value [0-255]
integer   $blue   —  blue RGB value [0-255]

[ Top ]

setVersion   [line 262]

void setVersion( integer $version)

Sets the BIFF version.

This method exists just to access experimental functionality from BIFF8. It will be deprecated ! Only possible value is 8 (Excel 97/2000). For any other value it fails silently.

  • Access: public

Parameters:

integer   $version   —  The BIFF version

[ Top ]

sheets   [line 235]

array sheets( )

An accessor for the _worksheets[] array Returns an array of the worksheet objects in a workbook It actually calls to worksheets()

[ Top ]

worksheets   [line 247]

array worksheets( )

An accessor for the _worksheets[] array.

Returns an array of the worksheet objects in a workbook

  • Access: public

[ Top ]


Documentation generated on Mon, 11 Mar 2019 15:47:15 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.