Sign in Join
FPDoc Onlineexperiment

TCustomTreeView.ApplyStoredSelection procedure

Member of TCustomTreeViewpublicIn unit ComCtrls

Selects the tree node with the access path represented in the specified string list.

Declaration

pascal
procedure ApplyStoredSelection(ASelection: TStringList; 
 FreeList: Boolean=True)

Arguments

ASelection

TStringList with the text for nodes used to access the selected tree node.

FreeListTrue if the TStringList instance is freed in the method.

Description

ApplyStoredSelection is used to locate a tree node in Items which matches the specified access path. ASelection contains values, as returned by StoreCurrentSelection, where each line is the text for a tree node in the path to the selected node.

ApplyStoredSelection searches the sibling and child nodes in Items to locate a tree node which matches the specified values. When a node is found, Selected is set to the TTreeNode instance located in the method. If a node is not found, Selected is set to Nil.

ApplyStoredSelection causes the OnSelectionChanged event handler to be signalled (when assigned) when the value in Selected is updated.

FreeList indicates whether ASelection is freed in the method. When set to False, the TStringList instance must be freed in the caller or a memory leak can occur.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.