XLSDbRead5: Class TXLSDbRead5

# Class TXLSDbRead5

Description | Hierarchy | Fields | Methods | Properties

## Unit

XLSDbRead5

## Declaration

`type TXLSDbRead5 = class(TComponent)`

## Description

Component for importing data sets (TDataset) into a XLSReadWriteII component.

## Hierarchy

- TComponent
- TXLSDbRead5

## Overview

### Methods

| `constructor Create(AOwner: TComponent); override;`
| `destructor Destroy; override;`
| `procedure Read;`

### Properties

| `property CellColors[Index:integer]: TXc12IndexColor read GetCellColors write SetCellColors;`
| `property Column: byte read FCol write FCol;`
| `property Dataset: TDataset read FDataset write FDataset;`
| `property ExcludeFields: TStrings read FExcludeFields write SetExcludeFields;`
| `property IncludeFields: TStrings read FIncludeFields write SetIncludeFields;`
| `property IncludeFieldnames: boolean read FIncludeFieldnames write FIncludeFieldnames;`
| `property IndentDetailTables: boolean read FIndentDetailTables write FIndentDetailTables;`
| `property ReadDetailTables: boolean read FReadDetailTables write FReadDetailTables;`
| `property FormatCells: boolean read FFormatCells write FFormatCells;`
| `property Row: word read FRow write FRow;`
| `property Sheet: integer read FSheet write FSheet;`
| `property XLS: TXLSReadWriteII5 read FXLS write SetXLS;`
| `property OnDbCell: TXLSDbCellEvent read FDbCellEvent write FDbCellEvent;`
| `property OnDbRecord: TXLSDbRecordEvent read FDbRecordEvent write FDbRecordEvent;`

## Description

### Methods

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

| `destructor Destroy; override;`
˜exclude

| `procedure Read;`
Starts reading the source ˜[link Dataset].

### Properties

| `property CellColors[Index:integer]: TXc12IndexColor read GetCellColors write SetCellColors;`
Cell colors used when ˜[link FormatCells] is on. The frist index (#0) is for the master table, the following for detail tables. There can be 8 levels, index 0..7

| `property Column: byte read FCol write FCol;`
Current column where the cells are inserted.

| `property Dataset: TDataset read FDataset write FDataset;`
Source data set.

| `property ExcludeFields: TStrings read FExcludeFields write SetExcludeFields;`
List of field names in the data set that not shall be imported.

| `property IncludeFields: TStrings read FIncludeFields write SetIncludeFields;`
List of field names in the data set that shall be imported. If the list is empty, all fileds are included.

| `property IncludeFieldnames: boolean read FIncludeFieldnames write FIncludeFieldnames;`
Write the names of the fields on the first row.

| `property IndentDetailTables: boolean read FIndentDetailTables write FIndentDetailTables;`
When True, detail tables are shifted one column to the right for each level.

| `property ReadDetailTables: boolean read FReadDetailTables write FReadDetailTables;`
When True, detail tables are read. When False, only the master table is read.

| `property FormatCells: boolean read FFormatCells write FFormatCells;`
When True, the color of the inserted cells are set according to the colors in ˜[link CellColors]

| `property Row: word read FRow write FRow;`
Current row where the cells are inserted.

| `property Sheet: integer read FSheet write FSheet;`
Index to the current sheet where the cells are inserted.

| `property XLS: TXLSReadWriteII5 read FXLS write SetXLS;`
The destination TXLSReadWriteII2 object.

| `property OnDbCell: TXLSDbCellEvent read FDbCellEvent write FDbCellEvent;`
Event fired when a cell is inserted. The event is fired after data is written to the cell. Use this event for user formatting of the cells, or changing the destination on where the cells are inserted.

| `property OnDbRecord: TXLSDbRecordEvent read FDbRecordEvent write FDbRecordEvent;`
Event fired when a record is read.

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