TcxCustomTreeList.OnGetStoredProperties Event

Allows you to customize a list of tree list properties saved to external storages.

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. The list is initially empty. You can add custom property names to this list and handle the 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 control that raised the OnGetStoredProperties event.

AProperties

Provides access to the list of stored properties.

Code Example

The following code demonstrates an OnGetStoredProperties event handler, demonstrating how to extend the list with items that correspond to the tree list’s OptionsView.Footer and OptionsView.GroupFooters properties.

Delphi

procedure TMyForm.cxTreeList1GetStoredProperties(Sender: TObject; AProperties: TStrings);
begin
  AProperties.Add('OptionsView_Footer');
  AProperties.Add('OptionsView_GroupFooters');
end;

C++

void __fastcall TMyForm::cxTreeList1GetStoredProperties(TObject *Sender, TStrings *AProperties)
{
  AProperties->Add("OptionsView_Footer");
  AProperties->Add("OptionsView_GroupFooters");
}

Note

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