Open topic with navigation

# TreeViewNode

# SAPGUI. TreeViewNode

TreeViewNode

# Constructor

## new TreeViewNode()

A TreeViewNode object

### Methods

## activateItem(itemOrIndex) → {Promise.<void>}

Activates an item in this node of a SAP column tree or list tree, by item text or index.

##### Parameters:

Name | Type | Description
--- | --- | ---
`itemOrIndex` | number | string | The item text or 0-based index.

##### Returns:

a promise that is fulfilled when the operation ends.

Type
  Promise.<void>

## clickButton(itemOrIndex) → {Promise.<void>}

Clicks the specified button item in this node of a SAP column tree or list tree, by button text or index.

##### Parameters:

Name | Type | Description
--- | --- | ---
`itemOrIndex` | number | string | The button text or 0-based index.

##### Returns:

a promise that is fulfilled when the operation ends.

Type
  Promise.<void>

## clickLink(itemOrIndex) → {Promise.<void>}

Clicks the specified link in this node of a SAP column tree or list tree, by link text or index.

##### Parameters:

Name | Type | Description
--- | --- | ---
`itemOrIndex` | number | string | The link text or 0-based index.

##### Returns:

a promise that is fulfilled when the operation ends.

Type
  Promise.<void>

## collapse() → {Promise.<void>}

Hides this node's sub-nodes in the expanded tree object.

##### Returns:

a promise that is fulfilled when the operation ends.

Type
  Promise.<void>

## expand() → {Promise.<void>}

Displays this node's sub-nodes in the tree object.

##### Returns:

a promise that is fulfilled when the operation ends.

Type
  Promise.<void>

## openContextMenu() → {Promise.<void>}

Opens the context menu for this node of a SAP simple tree.

##### Returns:

a promise that is fulfilled when the operation ends.

Type
  Promise.<void>

## openItemContextMenu(item) → {Promise.<void>}

Opens the context menu for the specified item in this node of a SAP column tree or list tree.

##### Parameters:

Name | Type | Description
--- | --- | ---
`item` | string | The text of the item.

##### Returns:

a promise that is fulfilled when the operation ends.

Type
  Promise.<void>

## path() → {string}

Get the path of the node.

##### Returns:

the path of the node.

Type
  string

## select(itemOrIndex) → {Promise.<void>}

Selects an item in this node of a SAP column tree or list tree, by item text or index.

##### Parameters:

Name | Type | Description
--- | --- | ---
`itemOrIndex` | number | string | The item text or 0-based index.

##### Returns:

a promise that is fulfilled when the operation ends.

Type
  Promise.<void>

## setCheckBoxState(itemOrIndex, state) → {Promise.<void>}

Selects or unselects a check box item for this node of a SAP column tree or list tree, by checkbox text.

##### Parameters:

Name | Type | Description
--- | --- | ---
`itemOrIndex` | number | string | The text or 0-based index of the check box.
`state` | boolean | True to select

##### Returns:

a promise that is fulfilled when the operation ends.

Type
  Promise.<void>