Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

TcxCustomTreeList.OnGetStoredProperties Event

In This Article

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

#Declaration

Delphi
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. By default, the list is 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.

The Sender parameter specifies the TreeList control whose properties are to be stored.

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

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.

procedure <Form>.<TreeList>GetStoredProperties(Sender: TObject; AProperties: TStrings);
begin
  AProperties.Add('OptionsView_Footer');
  AProperties.Add('OptionsView_GroupFooters');
end;

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.

See Also