XLSSheetData5: Class TXLSWorkbook

# Class TXLSWorkbook

Description | Hierarchy | Fields | Methods | Properties

## Unit

XLSSheetData5

## Declaration

`type TXLSWorkbook = class(TComponent)`

## Description

## Hierarchy

- TComponent
- TXLSWorkbook

## Overview

### Methods

| `destructor Destroy; override;`
| `procedure CreateMembers(AClassFactory: TXLSClassFactory; AManager: TXc12Manager; AFormulas: TXLSFormulaHandler);`
| `function Count: integer;`
| `procedure Delete(const AIndex: integer; ACount: integer = 1);`
| `procedure Insert(const AIndex: integer; ACount: integer = 1);`
| `procedure Clear;`
| `procedure ClearCells;`
| `function Add: TXLSWorksheet;`
| `function SheetByName(const Name: AxUCString): TXLSWorksheet;`
| `procedure AfterRead;`
| `procedure BeforeWrite;`
| `procedure CalcDimensions;`
| `procedure CompileFormulas;`
| `procedure Calculate;`
| `function GetWeakPassword: AXUCString;`
| `function MaxRowCount: integer;`
| `function MaxColCount: integer;`
| `function CopyCells(const ASrcSheet: integer; ASrcAreas: TBaseCellAreas; const ADestSheet,ADestCol,ADestRow: integer; CopyOptions: TCopyCellsOptions = [ccoAdjustCells] + CopyAllCells): boolean; overload;`
| `procedure CopyCells(SrcSheet,Col1,Row1,Col2,Row2,DestSheet,DestCol,DestRow: integer; const CopyOptions: TCopyCellsOptions = [ccoAdjustCells] + CopyAllCells); overload;`
| `procedure MoveCells(const SrcSheet,Col1,Row1,Col2,Row2,DestSheet,DestCol,DestRow: integer; const CopyOptions: TCopyCellsOptions = [ccoAdjustCells] + CopyAllCells);`
| `procedure DeleteCells(const ASheet: integer; AAreas: TBaseCellAreas); overload;`
| `procedure DeleteCells(const ASheet: integer; AArea: TCellArea); overload;`
| `procedure DeleteCells(const ASheet, ACol1, ARow1, ACol2, ARow2: integer); overload;`
| `procedure CopyColumns(const ASrcSheet,ACol1,ACol2,ADestSheet,ADestCol: integer);`
| `procedure MoveColumns(const ASrcSheet,ACol1,ACol2,ADestSheet,ADestCol: integer);`
| `procedure DeleteColumns(const ASheet,ACol1,ACol2: integer);`
| `procedure ClearColumns(const ASheet,ACol1,ACol2: integer);`
| `procedure InsertColumns(const ASheet,ACol,AColCount: integer);`
| `procedure CopyRows(const ASrcSheet,ARow1,ARow2,ADestSheet,ADestRow: integer);`
| `procedure MoveRows(const ASrcSheet,ARow1,ARow2,ADestSheet,ADestRow: integer);`
| `procedure DeleteRows(const ASheet,ARow1,ARow2: integer);`
| `procedure ClearRows(const ASheet,ARow1,ARow2: integer);`
| `procedure InsertRows(const ASheet,ARow,ARowCount: integer);`
| `procedure CopySheet(const ASrcSheet,ADestSheet: integer);`
| `procedure BeginFindText;`
| `function FindText(const Text: AxUCString; const CaseInsensitive: boolean = True): boolean;`
| `procedure GetFindData(var Sheet,Col,Row,TextPos: integer; var Text: AxUCString);`

### Properties

| `property Backup: boolean read GetBackup write SetBackup;`
| `property RefreshAll: boolean read GetRefreshAll write SetRefreshAll;`
| `property UserName: AxUCString read GetUserName write SetUserName;`
| `property NameAsFloat [constAName:AxUCString]: double read GetNameAsFloat write SetNameAsFloat;`
| `property NameAsString [constAName:AxUCString]: AxUCString read GetNameAsString write SetNameAsString;`
| `property NameAsFmtString [constAName:AxUCString]: AxUCString read GetNameAsFmtString;`
| `property NameAsBoolean [constAName:AxUCString]: boolean read GetNameAsBoolean write SetNameAsBoolean;`
| `property NameAsError [constAName:AxUCString]: TXc12CellError read GetNameAsError write SetNameAsError;`
| `property NameAsFormula [constAName:AxUCString]: AxUCString read GetNameAsFormula write SetNameAsFormula;`
| `property NameAsNumFormulaValue [constAName:AxUCString]: double read GetNameAsNumFormulaValue write SetNameAsNumFormulaValue;`
| `property NameAsStrFormulaValue [constAName:AxUCString]: AxUCString read GetNameAsStrFormulaValue write SetNameAsStrFormulaValue;`
| `property NameAsBoolFormulaValue[constAName:AxUCString]: boolean read GetNameAsBoolFormulaValue write SetNameAsBoolFormulaValue;`
| `property DefaultName: AxUCString read FDefaultName write SetDefaultName;`
| `property ShowFormulas: boolean read FShowFormulas write FShowFormulas;`
| `property OptionsDialog: TXLSOptionsDialog read FOptionsDialog;`
| `property WorkbookData: TXLSWorkbookData read FWorkbookData;`
| `property Formulas: TXLSFormulaHandler read FFormulas;`
| `property Names: TXLSNames read GetNames;`
| `property InternalNames: TXLSNames read GetInternalNames;`
| `property Palette[Index:integer]: TColor read GetPalette write SetPalette;`
| `property BIFF: TBIFF5 read FBIFF;`
| `property VBA: TXLSVBA read GetVBA;`
| `property Clipboard: TXLSClipboard read FXLSClipboard;`
| `property CmdFormat: TXLSCmdFormat read FCmdFormat;`
| `property DefaultFormat: TXLSDefaultFormat read FDefaultFormat write FDefaultFormat;`
| `property Font: TXc12Font read GetFont;`
| `property SelectedTab: integer read FSelectedTab write FSelectedTab;`
| `property DefaultPaperSize: TXc12PaperSize read FDefaultPaperSize write FDefaultPaperSize;`
| `property Items[Index:integer]: TXLSWorksheet read GetItems;`
| `property Sheets[Index:integer]: TXLSWorksheet read GetItems;`

## Description

### Methods

| `destructor Destroy; override;`

| `procedure CreateMembers(AClassFactory: TXLSClassFactory; AManager: TXc12Manager; AFormulas: TXLSFormulaHandler);`

| `function Count: integer;`

| `procedure Delete(const AIndex: integer; ACount: integer = 1);`

| `procedure Insert(const AIndex: integer; ACount: integer = 1);`

| `procedure Clear;`

| `procedure ClearCells;`

| `function Add: TXLSWorksheet;`

| `function SheetByName(const Name: AxUCString): TXLSWorksheet;`
Searches for a worksheet by it's name. ˜param Name The name of the worksheet. ˜result The TSheet object. If not found, Nil is returned.

| `procedure AfterRead;`

| `procedure BeforeWrite;`

| `procedure CalcDimensions;`

| `procedure CompileFormulas;`

| `procedure Calculate;`

| `function GetWeakPassword: AXUCString;`
Returns a password that can be used to unprotect worksheets. As the password is calculated, this may not be the same password used to protect it. ˜result A valid password that can unprotect the file. If there is no protection, an empty string is returned.

| `function MaxRowCount: integer;`
The max number of rows in a worksheet. 65536 for Excel 97 and 1048576 for Excel 2007.

| `function MaxColCount: integer;`
The max number of columns in a worksheet. 256 for Excel 97 and 16384 for Excel 2007.

| `function CopyCells(const ASrcSheet: integer; ASrcAreas: TBaseCellAreas; const ADestSheet,ADestCol,ADestRow: integer; CopyOptions: TCopyCellsOptions = [ccoAdjustCells] + CopyAllCells): boolean; overload;`

| `procedure CopyCells(SrcSheet,Col1,Row1,Col2,Row2,DestSheet,DestCol,DestRow: integer; const CopyOptions: TCopyCellsOptions = [ccoAdjustCells] + CopyAllCells); overload;`

| `procedure MoveCells(const SrcSheet,Col1,Row1,Col2,Row2,DestSheet,DestCol,DestRow: integer; const CopyOptions: TCopyCellsOptions = [ccoAdjustCells] + CopyAllCells);`

| `procedure DeleteCells(const ASheet: integer; AAreas: TBaseCellAreas); overload;`

| `procedure DeleteCells(const ASheet: integer; AArea: TCellArea); overload;`

| `procedure DeleteCells(const ASheet, ACol1, ARow1, ACol2, ARow2: integer); overload;`

| `procedure CopyColumns(const ASrcSheet,ACol1,ACol2,ADestSheet,ADestCol: integer);`

| `procedure MoveColumns(const ASrcSheet,ACol1,ACol2,ADestSheet,ADestCol: integer);`

| `procedure DeleteColumns(const ASheet,ACol1,ACol2: integer);`

| `procedure ClearColumns(const ASheet,ACol1,ACol2: integer);`

| `procedure InsertColumns(const ASheet,ACol,AColCount: integer);`

| `procedure CopyRows(const ASrcSheet,ARow1,ARow2,ADestSheet,ADestRow: integer);`

| `procedure MoveRows(const ASrcSheet,ARow1,ARow2,ADestSheet,ADestRow: integer);`

| `procedure DeleteRows(const ASheet,ARow1,ARow2: integer);`

| `procedure ClearRows(const ASheet,ARow1,ARow2: integer);`

| `procedure InsertRows(const ASheet,ARow,ARowCount: integer);`

| `procedure CopySheet(const ASrcSheet,ADestSheet: integer);`

| `procedure BeginFindText;`

| `function FindText(const Text: AxUCString; const CaseInsensitive: boolean = True): boolean;`

| `procedure GetFindData(var Sheet,Col,Row,TextPos: integer; var Text: AxUCString);`

### Properties

| `property Backup: boolean read GetBackup write SetBackup;`
The Backup property specifies whether Microsoft Excel should save backup versions of a file, when the file is opened with Excel.

| `property RefreshAll: boolean read GetRefreshAll write SetRefreshAll;`
Set the RefreshAll property to True if all external data should be refreshed when the workbook is loaded by Excel.

| `property UserName: AxUCString read GetUserName write SetUserName;`
The name of the creator of the workbook.

| `property NameAsFloat [constAName:AxUCString]: double read GetNameAsFloat write SetNameAsFloat;`

| `property NameAsString [constAName:AxUCString]: AxUCString read GetNameAsString write SetNameAsString;`

| `property NameAsFmtString [constAName:AxUCString]: AxUCString read GetNameAsFmtString;`

| `property NameAsBoolean [constAName:AxUCString]: boolean read GetNameAsBoolean write SetNameAsBoolean;`

| `property NameAsError [constAName:AxUCString]: TXc12CellError read GetNameAsError write SetNameAsError;`

| `property NameAsFormula [constAName:AxUCString]: AxUCString read GetNameAsFormula write SetNameAsFormula;`

| `property NameAsNumFormulaValue [constAName:AxUCString]: double read GetNameAsNumFormulaValue write SetNameAsNumFormulaValue;`

| `property NameAsStrFormulaValue [constAName:AxUCString]: AxUCString read GetNameAsStrFormulaValue write SetNameAsStrFormulaValue;`

| `property NameAsBoolFormulaValue[constAName:AxUCString]: boolean read GetNameAsBoolFormulaValue write SetNameAsBoolFormulaValue;`

| `property DefaultName: AxUCString read FDefaultName write SetDefaultName;`

| `property ShowFormulas: boolean read FShowFormulas write FShowFormulas;`

| `property OptionsDialog: TXLSOptionsDialog read FOptionsDialog;`

| `property WorkbookData: TXLSWorkbookData read FWorkbookData;`

| `property Formulas: TXLSFormulaHandler read FFormulas;`

| `property Names: TXLSNames read GetNames;`

| `property InternalNames: TXLSNames read GetInternalNames;`

| `property Palette[Index:integer]: TColor read GetPalette write SetPalette;`
The palette for the colors used by Excel. The palette has 64 entries, but the first 8 are fixed and can not be changed.

| `property BIFF: TBIFF5 read FBIFF;`

| `property VBA: TXLSVBA read GetVBA;`

| `property Clipboard: TXLSClipboard read FXLSClipboard;`

| `property CmdFormat: TXLSCmdFormat read FCmdFormat;`

| `property DefaultFormat: TXLSDefaultFormat read FDefaultFormat write FDefaultFormat;`

| `property Font: TXc12Font read GetFont;`

| `property SelectedTab: integer read FSelectedTab write FSelectedTab;`

| `property DefaultPaperSize: TXc12PaperSize read FDefaultPaperSize write FDefaultPaperSize;`

| `property Items[Index:integer]: TXLSWorksheet read GetItems;`

| `property Sheets[Index:integer]: TXLSWorksheet read GetItems;`

Generated by PasDoc 0.12.1 on 2013-03-18 12:36:48