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.RestoreFromStream(TStream,Boolean,Boolean,string) Method

Restores TreeList-specific information from a stream.

#Declaration

Delphi
procedure RestoreFromStream(AStream: TStream; AChildrenCreating: Boolean = False; AChildrenDeleting: Boolean = False; const ARestoreTreeListName: string = '');

#Parameters

Name Type
AStream TStream
AChildrenCreating Boolean
AChildrenDeleting Boolean
ARestoreTreeListName string

#Remarks

Use the RestoreFromStream method to restore TreeList-specific information from a stream. Restoring the TreeList structure can be useful after changes have been applied to the TreeList control. Before restoring the TreeList structure, ensure that the control contains all columns connected to the dataset fields at the time when data was saved to the stream.

Stored structure information includes: instance names, band and column settings. Stored elements’ (bands and columns) settings specify the position and visibility of elements, captions, sort order, data binding, etc.

The AChildrenCreating parameter determines whether non-existent TreeList elements (bands and columns) present within the stream are created within the control. On the contrary, the AChildrenDeleting parameter determines whether existing TreeList elements not present within the stream file are deleted when restoring.

For information on the ARestoreTreeListName parameter, see the RestoreFromIniFile method description.

See Also