Datasnap.DBClient.TCustomClientDataSet.GetGroupState

De RAD Studio API Documentation
Aller à : navigation, rechercher

Delphi

function GetGroupState(Level: Integer): TGroupPosInds;

C++

Data::Db::TGroupPosInds __fastcall GetGroupState(int Level);

Propriétés

Type Visibilité  Source Unité  Parent
function public
Datasnap.DBClient.pas
Datasnap.DBClient.hpp
Datasnap.DBClient TCustomClientDataSet

Description

Indique si l'enregistrement en cours fait partie du groupe spécifié d'enregistrements.

Appelez la méthode GetGroupState pour déterminer si l'enregistrement en cours fait partie du groupe d'enregistrements spécifié par le paramètre Level.

Level identifie un groupe par son niveau de regroupement dans l'index en cours. Le regroupement de niveau 1 est l'ensemble des enregistrements ayant la même valeur pour le premier champ de l'index. Le regroupement de niveau 2 est l'ensemble des enregistrements ayant la même valeur pour les deux premiers champs de l'index, etc. Si Level spécifie un niveau de regroupement supérieur à la valeur de la propriété GroupingLevel, GetGroupState déclenche une exception.

GetGroupState renvoie un ensemble qui indique si l'enregistrement en cours appartient au niveau de regroupement en cours. Il peut prendre l'une des valeurs suivantes :



Valeur Signification

[gbMiddle]

L'enregistrement en cours n'est ni le premier ni le dernier enregistrement du groupe.

[gbFirst]

L'enregistrement en cours est le premier du groupe qui contient au moins deux enregistrements.

[gbLast]

L'enregistrement en cours est le dernier du groupe qui contient au moins deux enregistrements.

[gbFirst,gbLast]

L'enregistrement en cours est le seul enregistrement du groupe.



Remarque :  Si AggregatesActive a la valeur false ou si l'index en cours ne gère pas les regroupements, GetGroupState renvoie un ensemble vide.

Voir aussi