Product Documentation

VCL/CLX Developers Guide

Previous Topic

Next Topic

Published properties

Active

property Active() : Boolean;

Indicate if a table is open or not. When set to True the active property opens the table. When set to False, the active property closes the table.

CreateMode

property CreateMode() : Integer;

This property sets the table creation mode. This property is optional and is only used when a new table is created. The valid values for the create mode property are given in “c-treeVCL/CLX Definitions”.

Database

property Database() : TComponent;

Set this property with the database component this table should be associated with. This property must be set before any other table operation.

DataExt

property DataExt :String

Use this property to set the data file filename extension. The default extension is .dat.

DefaultIndex

property DefaultIndex() : Integer;

This property indicates which index number should be used as the default index. To change the default index just set this property with the index number. If not set, the first index created is used as the default index.

Directory

property Directory() : String;

Sets the table directory location. This property is only used by the CreateTable() and AddTable() methods.

Exclusive

property Exclusive() : Boolean;

Use this property to indicate if a table is to be open with exclusive access or not.

Filter

property Filter() : String;

Filter is used to specify a dataset filter. When filtering is applied to a dataset, only those records that meet a filter's conditions are available to an application. Filter contains the string that describes the filter condition. Overrides the TDataSet::Filter() property.

The Filter property only holds the text of the conditional expression. Setting a value to Filter does not enable filtering. The Filtered property needs to be set to activate or deactivate filtering.

One important point to highlight is that, at the present time, the FairCom logic is used in the parser. See the discussion on conditional syntax to see how to use the FairCom parser.

Filtered

property Filtered() : Boolean;

Indicate if a filter is active for a record set. If Filtered() is True, then filtering is active. To apply filter conditions specified in the Filter property, set Filtered to True. Overrides the TDataSet::Filtered() property.

Groupid

property Groupid() : String;

Set this property with the table group id. This property is optional and should only be set when creating a new table.

IndexExt

property IndexExt :String;

Use this property to set the index filename extension. The default extension is .idx.

Password

property Password() : String;

Set this property with the table password. This property is optional and should only be set if the table was created or is to be created with a password set. If the table is created with a password, operations like Delete require the password to delete the table.

Permanent

property Permanent() : Boolean;

Use this property to indicate if a table is to be open in PERMANENT or VIRTUAL mode. The default value is False (the table open mode is VIRTUAL). Please see the c-tree Plus documentation for a more detailed discussion on PERMANENT or VIRTUAL open modes.

Permission

property Permission() : Integer;

Set the permission mask for the table. This property is optional and is only used when a new table is created. Please refer to “c-treeVCL/CLX Definitions” for valid values for the permission masks.

ReadOnly

property ReadOnly() : Boolean;

Set the table to read only mode. A CTDBRET_READONLY exception will occur should you attempt to write to the table.

Table

property Table() : String;

Set this property with the table name before activating (opening) the table.

TOCIndex