<TreeView Table>.ItemStatus (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

ItemStatus

Presentation

Example

A collapsed or expanded node can be visible or not

Selection bar

Runtime speed

See also

<TreeView Table>.ItemStatus (Function)

In french: <Table hiérarchique>.EtatElément

Returns the status of a node in a Treeview Table control: collapsed, expanded or not found.

Reminder: At runtime, a node is expanded when the node name is preceded by "-".

Example

// Status of a node
SWITCH TVT_Schedule.ItemStatus("Root" + TAB + "Node" + TAB + "Leaf2")
CASE taError: Trace("The node does not exist.")
CASE taExpand: Trace("The node is expanded.")
CASE taCollapse: Trace("The node is collapsed.")
END

Syntax

Status of a node by specifying the row number Hide the details

<Result> = <TreeView Table control>.ItemStatus([<Row number>])

<Result>: Integer constant

Status of specified node:
taCollapse The node is collapsed
taError Node not found
taExpand The node is expanded

<TreeView Table control>: Control name

Name of the TreeView Table control to be used.

<Row number>: Optional integer

Number of the row containing the node to use. If this parameter is not specified, the status of the node found in the current row is returned.

Status of a node by specifying its name Hide the details

<Result> = <TreeView Table control>.ItemStatus([<Node name>])

<Result>: Integer constant

Status of specified node:
taCollapse The node is collapsed
taError Node not found
taExpand The node is expanded

<TreeView Table control>: Control name

Name of the TreeView Table control to be used.

<Node name>: Optional character string

Name of node to use. This parameter has the following format:

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

A WLanguage error occurs if this parameter does not correspond to an existing branch.
If this parameter is not specified, the status of the node found in the current row is returned.

Remarks

A collapsed or expanded node can be visible or not

The status returned corresponds to the internal status of the element. An expanded element is not necessarily visible because one of its parents may be collapsed.

For example: If the node "Recipes" + TAB + "Desserts" is collapsed, the node" Recipes" + TAB + "Desserts" + TAB + "Ice creams" can be collapsed or expanded.

Selection bar

<TreeView Table>.ItemStatus does not change the position of the selection bar.

Runtime speed

The runtime speed of syntax 1 is faster than the runtime speed of syntax 2.

Component: wd280obj.dll