Data.SqlExpr.TSQLTable.IndexFieldNames

From RAD Studio API Documentation
Jump to: navigation, search

[–] Properties
Type: property
Visibility: published
Source:
Data.SqlExpr.pas
Data.SqlExpr.hpp
Unit: Data.SqlExpr
Parent: TSQLTable

Delphi

property IndexFieldNames: string read FIndexFieldNames write SetIndexFieldNames;

C++

__property System::UnicodeString IndexFieldNames = {read=FIndexFieldNames, write=SetIndexFieldNames};

Description

Lists the fields to use for sorting records and for linking in master/detail relationships.

IndexFieldNames is a semicolon-delimited set of field names, where each name specifies a field in the table.

Use IndexFieldNames to identify the fields in the SQL table that are used to sort records in the table. IndexFieldNames are used to generate the ORDER BY clause of the SQL statement automatically generated to fetch records for the dataset.

IndexFieldNames is also used to link this table as the detail in a master/detail relationship. Each of these fields must be matched to a corresponding field from the MasterFields property.

Instead of explicitly setting the sorting and linking fields using IndexFieldNames, you can indicate them using an existing index. To specify the sorting and linking fields implicitly through an index, use the IndexName property instead.

Note: The IndexName and IndexFieldNames properties are mutually exclusive. Setting one automatically clears the other.

See Also