TcxPivotGridField.OnGetStoredProperties Event

Enables you to customize a list of the current field’s properties to be stored to external data stores.

Declaration

property OnGetStoredProperties: TcxGetStoredPropertiesEvent read; write;

Remarks

Whenever the storing process is started by the StoreToIniFile, StoreToRegistry, or StoreToStream method call, a list of the properties to store is produced. When the OnGetStoredProperties event is fired, the list is already populated with field property names, which are stored by default. These property names are specified by the FieldDefaultStoredProperties global constant. You can add custom property names to the list and handle the field’s OnGetStoredPropertyValue and OnSetStoredPropertyValue events to provide property values to be saved to and restored from a data store. Make certain that items in the list uniquely identify the property names they correspond to.

The Sender parameter specifies the current field.

The AProperties parameter provides access to the list of properties to be stored.

The following code represents an OnGetStoredProperties event handler, demonstrating how to extend the list with an item that corresponds to a field’s DisplayFormat property.

Delphi

procedure <Form>.<Field>GetStoredProperties(Sender: TObject; AProperties: TStrings);
begin
  AProperties.Add('DisplayFormat');
end;

C++

void __fastcall <Form>::<Field>GetStoredProperties(TObject *Sender, TStrings *AProperties)
{
  AProperties->Add("DisplayFormat");
}

Note

To customize the manner in which pivot grid properties are persisted, handle the pivot grid’s OnGetStoredProperties, OnGetStoredPropertyValue, and OnSetStoredPropertyValue events.