TcxTreeListColumn.OnGetStoredProperties Event

Allows you to customize a list of column properties stored in external sources.

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 pre-populated with default column property names. These property names are specified by the ColumnPropertiesName global constant. You can add custom property names to the list and handle 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.

Event Parameters

Sender

Provides access to the tree list column that raised the OnGetStoredProperties event.

AProperties

Provides access to the list of storedd properties.

Code Example

The following code demonstrates how to extend the list with an item that corresponds to the Options.Footer property.

Delphi

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

C++

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

Note

To customize the manner in which tree list properties are persisted, handle the tree list’s OnGetStoredProperties, OnGetStoredPropertyValue, and OnSetStoredPropertyValue events. To customize the manner in which band properties are persisted, handle a band’s OnGetStoredProperties, OnGetStoredPropertyValue, and OnSetStoredPropertyValue events.