TxlDataSource Properties

Alias published read/write

A pseudonym for a dataset.

Is used in field formulas instead of referencing to DataSource.Name property. Useful in case of a report built on several datasets of the same name. Alias is equal to Name by default.

Column public read only

Returns the column number of the leftmost column of the range.

A range in Excel is described by its top left corner coordinates (Row, Column) and dimensions (RowCount, ColCount). This properties can be useful in event handlers of the TxlReport and TxlDataSource classes.

ColCount public read only

Returns the number of columns in the range.

A range in Excel is described by its top left corner coordinates (Row, Column) and dimensions (RowCount, ColCount). This properties can be useful in event handlers of the TxlReport and TxlDataSource classes.

DataSet published read/write

Binds a dataset to a report.

Specify the name of an existing dataset. At run-time use the following syntax:

If DataSet is nil then arbitrary data transfer is assumed and OnGetDataSourceInfo, OnGetFieldInfo and OnGetRecord events are triggered.

Enabled published read/write

Enables (disables) the data transfer from the corresponding dataset.

This property can be useful in report debugging.

MacroAfter published read/write

Contains the full name of the VBA procedure invoked after data transfer.

The full name contains the module name, dot, and the procedure name itself. The procedure must be declared public. Example:

See also OnMacro event.

MacroBefore published read/write

Contains the full name of the VBA procedure that must be invoked after data transfer.

The full name contains the module name, dot, and the procedure name itself. The procedure must be declared public. Example:

See also OnMacro event.

MasterSource public read/write

Is used in order to specify the range, containing the current range (specified in the Range property

Use this property in order to create master-detail relationships between datasets. In order to break a master-detail relationship, specify nil. Even if you specify master-detail relationships correctly you have to create a correct template - all ranges should be nested correctly.

MasterSourceName published read/write

Is used in order to specify the range, containing the current range (specified in the Range property

Use this case-insensitive property in order to create master-detail relationships between datasets. In order to specify the name of the master-range use the Alias of the master-range. In order to break a master-detail relationship, specify the empty string. Even if you specify master-detail relationships correctly you have to create a correct template - all ranges should be nested correctly.

Options published read/write

Contains various settings of the dataset and its range.

xrgoAutoClose (default True)

Setting this option to True will automatically close the dataset specified in the DataSet property immediately after its use. If this option is off the dataset will be left open.

xrgoAutoOpen (default True)

Setting this option to True will automatically open the dataset specified in the DataSet property. If this option is False and a dataset is not open - an exception is raised.

xrgoPreserveRowHeight (default True)

While processing Range-datasets, XL Report inserts rows in a range. By default, the height of each row is set according to the same of the template. This can cause slowing down the report generation speed. Set this option to False in order to avoid the slowing.

Range published read/write

Determines the name of the range in whose cells you want to transfer the data from the DataSet.

To transfer the data into a certain range of workbook you must name the range and specify it in the Range property. The cells of this range should contain field formulas on the =DataSetName_FieldName stencil. We describe format of XL Report ranges in Developer's Guide. If Range property is empty, XL Report will transfer to report workbook the current record only.

RangeType public read only

Returns the type of the range.

In order to provide additional possibilities of data transfer and processing, XL Report allows using range and column options. Some of the options can be used in certain range types only.

• rtNoRange - NoRange-dataset;
• rtRange - a standalone Range;
• rtRangeRoot - a top-level range including one or more nested ranges;
• rtRangeMaster - a range nested into another range and including one or more nested ranges;
• rtRangeDetail - a range nested into another range and having no nested ranges.

Report public read only

Points to the instance of TxlReport whose DataSources collection this instance of TxlDataSource belongs to.

Row public read only

Returns the column number of the leftmost column of the range.

A range in Excel is described by its top left corner coordinates (Row, Column) and dimensions (RowCount, ColCount). This properties can be useful in event handlers of the TxlReport and TxlDataSource classes.

RowCount public read only

Returns the number of columns in the range.

A range in Excel is described by its top left corner coordinates (Row, Column) and dimensions (RowCount, ColCount). This properties can be useful in event handlers of the TxlReport and TxlDataSource classes.

Tag published read/write

This is a standard property of VCL component classes.

Use it as you wish.