Class for generating Excel Spreadsheets
Located in /libraries/pear/Spreadsheet/Excel/Writer/Workbook.php (line 50)
PEAR | --Spreadsheet_Excel_Writer_BIFFwriter | --Spreadsheet_Excel_Writer_Workbook
Class | Description |
---|---|
![]() |
Class for writing Excel Spreadsheets. This class should change COMPLETELY. |
Flag for 1904 date system (0 => base date is 1900, 1 => base date is 1904)
The active worksheet of the workbook (0 indexed)
The BIFF file size for the workbook.
The codepage indicates the text encoding used for strings
The country code used for localization
Flag for preventing close from being called twice.
Filename for the Workbook
1st displayed worksheet in the workbook (0 indexed)
Array containing references to all of this workbook's formats
Array containing the colour palette
Formula parser
Number of workbook tabs selected
The default sheetname for all sheets created.
Array of sheetnames for creating the EXTERNSHEET records
number of bytes for sizeinfo of strings
The temporary dir for storing the OLE file
The default XF format.
The default format for URLs.
Array containing references to all of this workbook's worksheets
Index for creating adding new formats to the workbook
Inherited from Spreadsheet_Excel_Writer_BIFFwriter
Spreadsheet_Excel_Writer_BIFFwriter::$_BIFF_version
Spreadsheet_Excel_Writer_BIFFwriter::$_byte_order
Spreadsheet_Excel_Writer_BIFFwriter::$_data
Spreadsheet_Excel_Writer_BIFFwriter::$_datasize
Spreadsheet_Excel_Writer_BIFFwriter::$_limit
Class constructor
Add a new format to the Excel workbook.
Also, pass any properties to the Format constructor.
Create new validator.
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..].
Calls finalization methods.
This method should always be the last one to be called on every workbook
Set the country identifier for the workbook
Change the RGB components of the elements in the colour palette.
Sets the temp dir used for storing the OLE file
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.
An accessor for the _worksheets[] array Returns an array of the worksheet objects in a workbook It actually calls to worksheets()
An accessor for the _worksheets[] array.
Returns an array of the worksheet objects in a workbook
Calculate offsets for Worksheet BOF records.
Calculate
Handling of the SST continue blocks is complicated by the need to include an additional continuation byte depending on whether the string is split between blocks or whether it starts at the beginning of the block. (There are also additional complications that will arise later when/if Rich Strings are supported).
Sets the colour palette to the Excel 97+ default.
Store the Excel FONT records.
Store user defined numerical formats i.e. FORMAT records
Write all STYLE records.
Write all XF records.
Writes Excel BIFF BOUNDSHEET record.
FIXME: inconsistent with BIFF documentation
Stores the CODEPAGE biff record.
Stores the COUNTRY record for localization
Write DATEMODE record to indicate the date system in use (1904 or 1900).
Write BIFF record EXTERNCOUNT to indicate the number of external sheet references in the workbook.
Excel only stores references to external sheets that are used in NAME. The workbook NAME record is required to define the print area and the repeat rows and columns.
A similar method is used in Worksheet.php for a slightly different purpose.
Write the EXTERNCOUNT and EXTERNSHEET records. These are used as indexes for the NAME records.
Writes the Excel BIFF EXTERNSHEET record. These references are used by formulas. NAME record is required to define the print area and the repeat rows and columns.
A similar method is used in Worksheet.php for a slightly different purpose.
Writes the Excel BIFF EXTERNSHEET record. These references are used by formulas.
Store the NAME record in the long format that is used for storing the repeat rows and columns when both are specified. This shares a lot of code with _storeNameShort() but we use a separate method to keep the code clean.
Code abstraction for reuse can be carried too far, and I should know. ;-)
Write the NAME record to define the print area and the repeat rows and cols.
Store the NAME record in the short format that is used for storing the print area, repeat rows only and repeat columns only.
Writes Excel FORMAT record for non "built-in" numerical formats.
Store the workbook in an OLE container
Stores the PALETTE biff record.
Write all of the workbooks strings into an indexed array.
See the comments in _calculate_shared_string_sizes() for more information.
The Excel documentation says that the SST record should be followed by an EXTSST record. The EXTSST record is a hash table that is used to optimise access to SST. However, despite the documentation it doesn't seem to be required so we will ignore it.
Write Excel BIFF STYLE records.
Write Internal SUPBOOK record
Write Excel BIFF WINDOW1 record.
Assemble worksheets into a workbook and send the BIFF data to an OLE storage.
Inherited From Spreadsheet_Excel_Writer_BIFFwriter
Spreadsheet_Excel_Writer_BIFFwriter::Spreadsheet_Excel_Writer_BIFFwriter()
Spreadsheet_Excel_Writer_BIFFwriter::_addContinue()
Spreadsheet_Excel_Writer_BIFFwriter::_append()
Spreadsheet_Excel_Writer_BIFFwriter::_prepend()
Spreadsheet_Excel_Writer_BIFFwriter::_setByteOrder()
Spreadsheet_Excel_Writer_BIFFwriter::_storeBof()
Spreadsheet_Excel_Writer_BIFFwriter::_storeEof()
Documentation generated on Fri, 11 Feb 2005 18:14:39 +0000 by phpDocumentor 1.3.0RC3