Xbasic

Office::Excel2003Document Class

Description

The Office::Excel2003Document class is the parent class for creation and editing of Excel 2003 (.xls) documents.

Properties

CallResultCallResult

CallResult property

FileNameCharacter

String FileName property

ActiveSheetIndexNumeric

Numeric ActiveSheetIndex property

ErrorMessageCharacter

String ErrorMessage property

SheetCountNumeric

Numeric SheetCount property

FormatCountNumeric

Numeric FormatCount property

FontCountNumeric

Numeric FontCount property

Methods

AddFont Method

Create a new font and add it to the document. You can pass an existing font to copy its values into the new one.

AddFormat Method

Create a new format and add it to the document. You can pass an existing format to copy its values into the new one.

AddPicture Method

Add a new picture to the document. The image can be specified as a file name or blob value.

AddSheet Method

Add a new spreadsheet to the document assigning it the name provided.

AddSheetFromDBF Method

Create a new spreadsheet from a DBF file and add it to the document.

AddSheetFromResultSet Method

Create a new spreadsheet from a SQL::ResultSet and add it to the document.

Clear Method

Reinitialize the Excel document as a new one. Any unsaved data will be lost when this method is called.

CopySheet Method

Add a new spreadsheet to the document with the name specified by copying the contents of the sheet at index N.

CustomNumericFormat Method

Get the format expression for the custom numeric format at the index specified.

DefaultFont Method

Get the default font name and size for this workbook.

DeleteSheet Method

Delete the sheet at the index specified from the Excel document.

FindSheet Method

Get a spreadsheet by name.

GetFont Method

Get the font indexed by Index. Index must be a value between 1 and the number of fonts returned by the FontCount property.

GetFormat Method

Get the format indexed by Index. Index must be a value between 1 and the number of formats returned by the FormatCount property.

GetSheet Method

Get the spreadsheet at the index specified.

Load Method

Load the contents of an existing Excel 2003 (.xls) file.

LoadFromBlob Method

Load the Excel Document from a memory image of an Excel 2003 (.xls) file.

Save Method

Save the document to an Excel 2003 (.xls) file.

SaveToBlob Method

Save the document to a memory image of an Excel 2003 (.xls) file.

SetActiveSheet Method

Set the index of the spreadsheet that is considered active/current.

SetDefaultFont Method

Set a default font name and size for this workbook.

SetLocale Method

Set the locale name for the document.

The Office::Excel2003Document class is for working with Excel 2003 (.xls) files. For Excel 2007 (.xlsx) files, use Office::ExcelDocument.

See Also