TreeCopyItem (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Copying an element onto itself
Duplicates
Priority order for the sort

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

TreeCopyItem (Function)

In french: ArbreCopieElément

Copies an element (leaf or node) into a TreeView control. All branches issued from this element are also copied.

Example of TreeView control:

Example

// Copy the "Pineapple" leaf into the "Starters" node
// in the "TREE_RecipeTV" control
Res = TreeCopyItem(TREE_RecipeTV, ...
"Recipes" + TAB + "Desserts" + TAB + "Fruit salad", ...
"Recipes" + TAB + "Starters", tvFirst)

Syntax

<Result> = TreeCopyItem(<TreeView control> , <Source element> , <Destination element> [, <Sort mode>])

<Result>: Boolean

True if the element was copied,
False otherwise.

<TreeView control>: Control name

Name of TreeView control to use.

<Source element>: Character string

Path of element (leaf or node) to copy. This element and all the branches issued from this element will be moved. This parameter has the following format:

"<Name of root>" + TAB + ["<Name of 1st node>" + TAB + ...
["<Name of 2nd node>" + TAB + [...]]]"<Leaf name>"

In case of duplicates on a path element, this path can contain the element identifier (specified at the end of its name by TreeID).

<Destination element>: Character string

Path of element (leaf or node) corresponding to the new "parent" node of the copied element. This element must exist. This parameter:
has the following format:

"<Name of root>" + TAB + ["<Name of 1st node>" + TAB + ..
["<Name of 2nd node>" + TAB + [...]]]"<Leaf name>"

In case of duplicates on a path element, this path can contain the element identifier (specified at the end of its name by TreeID).
corresponds to the NULL constant if the "parent" node is the root of the TreeView control.

<Sort mode>: Optional constant (or combination of constants)

Position of the copied element in relation to the "child" elements of the destination node.
tvAcceptDuplicate The duplicates are accepted (two elements on the same level can have the same name). The copied element is inserted in alphabetical order, among the elements of the same level.
tvLast The element is copied to the last spot of the level.
tvFirst The element is copied to the first spot of the level.
tvAlphaSort
(Default value) The copied element is sorted in alphabetical order, among the elements of the same level.

Remarks

Copying an element onto itself

An element cannot be copied onto itself or onto one of its children. In this case, TreeCopyItem returns False and the element is not copied.

Duplicates

Two cases may occur if the <Destination element> already contains a child with the same name as the <Source element>:

If the duplicates are accepted (tvAcceptDuplicate constant), the copy is performed as usual. TreeCopyItem returns True.
If the duplicates are not accepted, TreeCopyItem returns False. The element is not copied.

If the <Source element> contains duplicates associated with the identifier, the duplicates will be copied with the same identifier.

Priority order for the sort

The priority order of parameters for the add mode is as follows:

tvFirst
tvLast
tvAlphaSort

For example, in tvFirst + tvLast + tvAlphaSort, only the tvFirst constant is taken into account and run.

Component : wd260obj.dll