TcxPivotGridGetGroupValueDisplayTextEvent Type

The text-related procedural type for data groups.

Declaration

TcxPivotGridGetGroupValueDisplayTextEvent = procedure(Sender: TcxPivotGridField; const AGroupValue: Variant; var AText: string) of object;

Parameters

Name	Type	Description
Sender	TcxPivotGridField	The pivot grid field that raised the event.
AGroupValue	Variant	The target grouping value.
AText	string	The target group’s display text.

Remarks

The following OnGetGroupValueDisplayText event handler encloses all grouping values in parentheses:

Delphi

procedure TForm1.cxPivotGrid1Field1GetGroupValueDisplayText(
  Sender: TcxPivotGridField; const AGroupValue: Variant; var AText: string);
begin
  AText := '(' + AText + ')';
end;

C++

void TForm1::cxPivotGrid1Field1GetGroupValueDisplayText(
  TcxPivotGridField *Sender, const Variant &AGroupValue, UnicodeString &AText)
{
  AText = "(" + AText + ")";
}

A pivot grid field’s OnGetGroupValueDisplayText event references the TcxPivotGridGetGroupValueDisplayTextEvent type.