diff --git a/docs/xml/lcl/comctrls.xml b/docs/xml/lcl/comctrls.xml index 85b3eb8e56..1b4b5c083a 100644 --- a/docs/xml/lcl/comctrls.xml +++ b/docs/xml/lcl/comctrls.xml @@ -37772,31 +37772,81 @@ not been assigned. -Creates and fills a TStringList with the text for the selected nodes on the -tree view control. +Creates and fills a TStringList with the text for each of the tree nodes in the +access path to the Selected node on the tree view control.

+StoreCurrentSelection uses the Selected property to determine the +values returned in the TStringList instance. The Text for each of the TTreeNode +instances is inserted in the return value in the order the nodes were visited +to reach the Selected node. The Text for each of the tree nodes appears on a +separate line. +

+

+If multi-selection is enabled on the tree view control, the first node in +Selections is used in the method (same value as Selected). +

+

It is the responsibility of the calling routine to free the TStringList instance in the return value. Failure to do so will result in a memory leak.

- + + + + +
-TStringList instance with the selected nodes in the control. + +TStringList instance with the text for the nodes in the path to the selected +node on the control. + -Selects the first node with text matching a value in the specified list. +Selects the tree node with the access path represented in the specified string +list. - - + +

+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. +

+
+ + + + + + + + + +
-TStringList with the text for nodes selected in the method. +TStringList with the text for nodes used to access the selected tree node.