Data.DB.TAggregateField.IndexName

From RAD Studio API Documentation
Jump to: navigation, search

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

Delphi

property IndexName: string read FIndexName write SetIndexName;

C++

__property System::UnicodeString IndexName = {read=FIndexName, write=SetIndexName};

Description

Specifies the index that is used to define subgroups of records.

Set IndexName to specify an index that sorts the records of the client dataset into subgroups. Each subgroup is defined as a set of records that all have the same values on a set of fields. This defining set of fields is the first GroupingLevel fields of the index.

IndexName is required for any aggregate that does not summarize all the records in the client dataset (GroupingLevel = 0). When the index associated with an aggregate is not the current index of the client dataset, its value is unavailable.

See Also