TreeViewNode

StdWin. TreeViewNode

TreeViewNode

Constructor

new TreeViewNode()

A TreeViewNode object

Methods

clickState() → {Promise.<void>}

Clicks the state icon.
Returns:
a promise that is fulfilled when the operation ends.
Type
Promise.<void>

collapse() → {Promise.<void>}

Hides the sub-nodes of the specified node in the expanded tree-view control.
Returns:
a promise that is fulfilled when the operation ends.
Type
Promise.<void>

doubleClickState() → {Promise.<void>}

Double-clicks the state icon.
Returns:
a promise that is fulfilled when the operation ends.
Type
Promise.<void>

dragAndDropOn(target, dragOptionsopt) → {Promise.<void>}

Drags and drops a test object onto the specified target object according to the specified DragOptions behavior.
Parameters:
Name Type Attributes Description
target TestObject | Object The target object on which this object is dropped.
dragOptions Object <optional>
The drag and drop behavior to apply.
Properties
NameTypeAttributesDefaultDescription
buttonMouseButton <optional>
MouseButton.left The mouse button used to drag the object.
dragLocationLocation <optional>
The point on the source object where the drag operation begins.
dropLocationLocation <optional>
The point on the target object where the drag and drop operation ends.
Returns:
a promise that is fulfilled when the drop operation ends.
Type
Promise.<void>

enableLabelEditing() → {Promise.<void>}

Activates the edit mode for the node in the tree-view control to enable renaming.
Returns:
a promise that is fulfilled when the operation ends.
Type
Promise.<void>

expand() → {Promise.<void>}

Displays the hidden sub-nodes of the specified node in the tree-view control.
Returns:
a promise that is fulfilled when the operation ends.
Type
Promise.<void>

expandAll() → {Promise.<void>}

Expands the node in the tree-view control and all of the nodes below it.
Returns:
a promise that is fulfilled when the operation ends.
Type
Promise.<void>

firstChildPath() → {Promise.<string>}

Gets the full path of the node's first child node as a semi-colon delimited string.
Returns:
a promise that is fulfilled with the full path of the node's first child node.
Type
Promise.<string>

hasChildren() → {Promise.<boolean>}

Checks if the node has children.
Returns:
a promise that is fulfilled with an indication of whether the node has children or not.
Type
Promise.<boolean>

imageIndex() → {Promise.<number>}

Gets the image index of the node.
Returns:
a promise that is fulfilled with the image index of the node.
Type
Promise.<number>

isExpanded() → {Promise.<boolean>}

Checks if the node is expanded.
Returns:
a promise that is fulfilled with an indication of whether the node is expanded or not.
Type
Promise.<boolean>

isSelected() → {Promise.<boolean>}

Checks if the node is selected.
Returns:
a promise that is fulfilled with an indication of whether the node is selected or not.
Type
Promise.<boolean>

nextSiblingPath() → {Promise.<string>}

Gets the full path of the node's next sibling node as a semi-colon delimited string.
Returns:
a promise that is fulfilled with the full path of the node's next sibling node.
Type
Promise.<string>

overlayImageIndex() → {Promise.<number>}

Gets the index number of the current overlay image.
Returns:
a promise that is fulfilled with the index number of the current overlay image.
Type
Promise.<number>

parentPath() → {Promise.<string>}

Gets the full path of the node's parent node as a semi-colon delimited string.
Returns:
a promise that is fulfilled with the full path of the node's parent node.
Type
Promise.<string>

path() → {Promise.<string>}

Gets the full path of the node as a semi-colon delimited string.
Returns:
a promise that is fulfilled with the full path of the node.
Type
Promise.<string>

setNodeState(state) → {Promise.<void>}

Sets the state of the check box icon of the specified node in the tree-view control.
Parameters:
Name Type Description
state number The state index.
Returns:
a promise that is fulfilled when the operation ends.
Type
Promise.<void>

state() → {Promise.<number>}

Gets the state image index of the node.
Returns:
a promise that is fulfilled with the state image index of the node.
Type
Promise.<number>

text() → {Promise.<string>}

Gets the text of the node.
Returns:
a promise that is fulfilled with the text of the node.
Type
Promise.<string>