<TreeView Table>.MoveBranch (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

TreeView Table functions

Prefix syntax

MoveBranch

Presentation

Example

See also

<TreeView Table>.MoveBranch (Function)

In french: <Table hiérarchique>.DéplaceBranche

Moves the content of a row as well as its entire descending tree structure in a TreeView Table control.

Example

// Positions the content of branch 1
// as child of branch 19 in the TreeView Table control
TVT_Customer.MoveBranch(1, 19, tmInChild)

// Positions the content of "My Documents\To Do" branch
// as child of branch 1 in the TreeView Table control
TVT_FOLDERS.MoveBranch("My documents" + TAB + ...
"To do", 1, tmInChild)

// Positions the content of branch 1 as root of the TreeviewTable control
TVT_Customer.MoveBranch(1, Null, tmInChild)

Syntax

<Result> = <TreeView Table control>.MoveBranch(<Element to move> , <Destination element> , <Type of move>)

<Result>: Integer

Actual position at which the row was moved. This position is equal to the subscript of the row destination only if the destination is before the source in the TreeView Table control.

<TreeView Table control>: Control name

Name of the TreeView Table control to be used.

<Element to move>: Integer or character string

Branch to move. This branch can be identified:
by the index of the branch to move. This index must be between 1 and the number of control rows (returned by the <Table>.Count function or the Count property).
by the path of the element to move. This parameter has the following format:

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

<Destination element>: Integer or character string

Destination branch. This branch can be identified:
by the index of the destination branch. This index must be between 1 and the number of control rows (returned by the <Table>.Count function or the Count property).
by the path of the destination element. This parameter has the following format:

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

by 'Null' or empty string ("") to specify the root of the tree structure.

<Type of move>: Boolean constant

Type of move to perform:
tmInChild The branch is moved and it will be the first child of destination branch. The branch moved will be positioned one level below the destination branch in the hierarchy.
tmInSibling The branch is moved and it will be the next sibling of the destination branch. The branch moved will be positioned on the same hierarchy level as the destination branch but at the following position.

Component: wd280obj.dll