XLSReadWriteII5: Class TXLSReadWriteII5

# Class TXLSReadWriteII5

Description | Hierarchy | Fields | Methods | Properties

## Unit

XLSReadWriteII5

## Declaration

`type TXLSReadWriteII5 = class(TXLSWorkbook)`

## Description

no description available, TXLSWorkbook description follows

## Hierarchy

- TComponent
- TXLSWorkbook
- TXLSReadWriteII5

## Overview

### Methods

| `constructor Create(AOwner: TComponent); override;`
| `destructor Destroy; override;`
| `procedure Clear(ADefaulSheetsCount: integer = 1);`
| `procedure Read;`
| `procedure LoadFromFile(AFilename: AxUCString);`
| `procedure LoadFromStream(AStream: TStream; const AAutoDetect: boolean = True);`
| `procedure LoadFromStream97(AStream: TStream);`
| `procedure Write;`
| `procedure SaveToFile(AFilename: AxUCString);`
| `procedure SaveToStream(AStream: TStream);`
| `procedure SetDirectWriteArea(const ASheetIndex,ACol1,ARow1,ACol2,ARow2: integer);`

### Properties

| `property BIFF: TBIFF5 read FBIFF;`
| `property ReadVBA: boolean read FReadVBA write FReadVBA;`
| `property StrTRUE: AxUCString read GetStrTRUE write SetStrTRUE;`
| `property StrFALSE: AxUCString read GetStrFALSE write SetStrFALSE;`
| `property Password: AxUCString read GetPassword write SetPassword;`
| `property Manager: TXc12Manager read FManager;`
| `property ComponentVersion: AxUCString read GetVersionNumber write SetVerionNumber;`
| `property Version: TExcelVersion read GetVersion write SetVersion;`
| `property Filename: AxUCString read GetFilename write SetFilename;`
| `property DirectRead: boolean read GetDirectRead write SetDirectRead;`
| `property DirectWrite: boolean read GetDirectWrite write SetDirectWrite;`
| `property Errors: TXLSErrorManager read FErrors;`
| `property OnReadCell : TCellReadWriteEvent read GetCellReadEvent write SetCellReadEvent;`
| `property OnWriteCell: TCellReadWriteEvent read GetCellWriteEvent write SetCellWriteEvent;`
| `property OnPassword : TPasswordEvent read FPasswordEvent write FPasswordEvent;`
| `property OnFunction : TFunctionEvent read FFunctionEvent write FFunctionEvent;`
| `property OnProgress : TXLSProgressEvent read GetProgressEvent write SetProgressEvent;`

## Description

### Methods

| `constructor Create(AOwner: TComponent); override;`

| `destructor Destroy; override;`

| `procedure Clear(ADefaulSheetsCount: integer = 1);`
Deletes all data from the workbook and adds ADefaulSheetsCount worksheets.

| `procedure Read;`
Reads the Excel file give by Filename.

| `procedure LoadFromFile(AFilename: AxUCString);`
Does the same thing as Filename and Read but in one call. The Filename property is set to AFilname.

| `procedure LoadFromStream(AStream: TStream; const AAutoDetect: boolean = True);`
Reads an Excel file from a stream. If AAutoDetect is True the method will try to detect if the stream is an Excel 2007 or an Excel 97 stream. If you explicite want to read an Excel 97 file, use LoadFromStream97.

| `procedure LoadFromStream97(AStream: TStream);`
Reads an Excel 97 file from a stream. If you want to read an Excel 2007+ file, use LoadFromStream.

| `procedure Write;`
Writes the data the file give by Filename.

| `procedure SaveToFile(AFilename: AxUCString);`
Does the same thing as Filename and Write but in one call. The Filename property is set to AFilname.

| `procedure SaveToStream(AStream: TStream);`
Saves the data to a stream.

| `procedure SetDirectWriteArea(const ASheetIndex,ACol1,ARow1,ACol2,ARow2: integer);`
Sets the are you want to fill with cell values when using DirectWrite.

### Properties

| `property BIFF: TBIFF5 read FBIFF;`

| `property ReadVBA: boolean read FReadVBA write FReadVBA;`

| `property StrTRUE: AxUCString read GetStrTRUE write SetStrTRUE;`
Change StrTRUE property to change the string representation of the boolean value True. The default is 'TRUE'. See also StrFALSE

| `property StrFALSE: AxUCString read GetStrFALSE write SetStrFALSE;`
Change StrFALSE property to change the string representation of the boolean value False. The default is 'FALSE'. See also StrTRUE

| `property Password: AxUCString read GetPassword write SetPassword;`
The password for encrypted files.

| `property Manager: TXc12Manager read FManager;`

| `property ComponentVersion: AxUCString read GetVersionNumber write SetVerionNumber;`
The version of the TXLSReadWriteII5 component.

| `property Version: TExcelVersion read GetVersion write SetVersion;`
The Excel file version for the workbook. When reading files, Version is set according to the file extension. xls and xlm = xvExcel97 xlsx and xlsm = xvExcel2007 See also `Xc12Utils5.TExcelVersion`, `a_ExcelFiles`

| `property Filename: AxUCString read GetFilename write SetFilename;`
The name of the Excel file.

| `property DirectRead: boolean read GetDirectRead write SetDirectRead;`
When DirectRead mode is active, the cell values are not stored in memory. Instead is the OnReadCell event fired when a cell is read. You can then access the cell value in the `Xc12Manager5.TXLSEventCell` object, ACell parameter, in the event. The advantage with the DirectRead mode is that no memory is used for storing cell values. As Excel 2007+ files can have 100 of millions of cells this can be a greate memory save. If you know that you just want a few cells, or going to store them elsewhere, this is a good choice. See also DirectWrite.

| `property DirectWrite: boolean read GetDirectWrite write SetDirectWrite;`
DirectWrite mode writes cell values directly to the disk file instead of first storing them in memory. This can save hughe ammount of memory if you are writing large files. See also DirectRead.

| `property Errors: TXLSErrorManager read FErrors;`
Error manager. See XLSUtils5.TXLSErrorManager.

| `property OnReadCell : TCellReadWriteEvent read GetCellReadEvent write SetCellReadEvent;`

| `property OnWriteCell: TCellReadWriteEvent read GetCellWriteEvent write SetCellWriteEvent;`

| `property OnPassword : TPasswordEvent read FPasswordEvent write FPasswordEvent;`

| `property OnFunction : TFunctionEvent read FFunctionEvent write FFunctionEvent;`

| `property OnProgress : TXLSProgressEvent read GetProgressEvent write SetProgressEvent;`

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