FireDAC.Comp.DataSet.TFDDataSet.GroupingLevel

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

property GroupingLevel: Integer read GetGroupingLevel;

C++

__property int GroupingLevel = {read=GetGroupingLevel, nodefault};

Properties

Type Visibility Source Unit Parent
property public
FireDAC.Comp.DataSet.pas
FireDAC.Comp.DataSet.hpp
FireDAC.Comp.DataSet TFDDataSet

Description

Returns the depth of grouping support provided by the current index.

Read the GroupingLevel property to determine the maximum level group for which grouping support is available. The datasets provide grouping support through the GetGroupState method, which indicates where the current record falls within a group. 

A group is defined as the set of records that have the same value on each of a set of fields. A level 0 group is the set of all records in the dataset. A level 1 group is the set of records with the same value on the first field of the index. A level 2 group is the set of records with the same values on each of the first two fields of the index. A level n group is the set of records with the same values on each of the first n fields of the index. 

By default, GroupingLevel is the default grouping level of the current index or the maximum grouping level of a maintained aggregate on the current index, whichever is greater. GroupingLevel can never be greater than IndexFieldCount.

See Also