Interface ITreeView

Namespace

HP.LFT.SDK.SAP.GUI

Assembly

HP.LFT.SDK.dll

A column tree, list tree, or simple tree control in a SAP GUI for Windows application.

public interface ITreeView : IElement, ITestObject, ITestObjectDescriber, ILocationInfoProvider, ISupportsNativeObject, IEnabledProvider

Inherited Members

IElement.Type

IElement.Id

IElement.Name

ITestObject.GetDescription()

ITestObject.SetDescription(IDescription)

ITestObject.FindChildren<TChild>(IDescription)

ITestObject.Exists()

ITestObject.Exists(uint)

ITestObject.GetSnapshot()

ITestObject.Highlight()

ITestObject.HighlightMatches<TChild>(IDescription)

ITestObject.GetTextLocations(string)

ITestObject.GetTextLocations(string, Rectangle)

ITestObject.GetVisibleText()

ITestObject.GetVisibleText(Rectangle)

ITestObject.VerifyImageExists(Image, byte)

ITestObject.VerifyImageMatch(Image, byte, byte)

ITestObject.VerifyImageMatch(Image, ImageMaskArea, byte, byte)

ITestObject.CallFTMethod(string, params object[])

ITestObject.CallFTMethod<TResult>(string, params object[])

ITestObject.Parent

ITestObject.DisplayName

ITestObjectDescriber.Describe<TChild>(IDescription)

ILocationInfoProvider.Location

ILocationInfoProvider.AbsoluteLocation

ILocationInfoProvider.Size

ISupportsNativeObject.NativeObject

IEnabledProvider.IsEnabled

Extension Methods

TestObjectExtensions.WaitUntilEnabled<T>(T)

TestObjectExtensions.WaitUntilEnabled<T>(T, int)

TestObjectExtensions.WaitUntilExists<T>(T)

TestObjectExtensions.WaitUntilExists<T>(T, int)

TestObjectExtensions.WaitUntil<T>(T, Func<T, bool>)

TestObjectExtensions.WaitUntil<T>(T, Func<T, bool>, int)

Properties

SelectedItem

The value of the selected item in the tree node.

string SelectedItem { get; }

Property Value

string

SelectedNodePath

The path to the selected node. The semicolon delimited list of nodes in the path.

string SelectedNodePath { get; }

Property Value

string

SelectionMode

Indicates which selections can be made in the tree.

TreeSelectionMode SelectionMode { get; }

Property Value

TreeSelectionMode

TreeType

Indicates the type of tree.

TreeType TreeType { get; }

Property Value

TreeType

Methods

ActivateNode(ITreeViewNode)

Activates the provided node in the tree.

void ActivateNode(ITreeViewNode node)

Parameters

node ITreeViewNode

The node.

ActivateNode(string)

Activates the specified node in the tree by path.

void ActivateNode(string path)

Parameters

path string

Nodes in the path can be specified by name or 1-based index in the format "#index".

Remarks

Use the BuildNodePath method to build the path argument.

You can use regular expressions for elements in the path. The format is: RegExp:=(regular expression).

BuildNodePath(params object[])

Returns the path constructed from the specified path elements.

string BuildNodePath(params object[] nodePathParts)

Parameters

nodePathParts object[]

The node path elements can be: logical name (string), full path (string), or 1-based index (int).

Returns

string

ClickColumn(string)

Clicks the specified column in this column tree or list tree, by name

void ClickColumn(string column)

Parameters

column string

The name of the column to click.

ClickColumn(uint)

Clicks the specified column in this column tree or list tree, by index.

void ClickColumn(uint columnIndex)

Parameters

columnIndex uint

1-based.

GetNode(string)

Returns the node with the specified path. If the path is not unique, returns the first node with the specified path.

ITreeViewNode GetNode(string path)

Parameters

path string

Elements of the path are separated by semi-colons (;).

Returns

ITreeViewNode

Remarks

Use the BuildNodePath method to build the node path string to be used as the path argument for this method.

OpenContextMenu()

Opens a tree's default context menu.

void OpenContextMenu()

Remarks

After opening a context menu, you can use the SelectMenuItemById method to select the menu item.

OpenHeaderContextMenu(string)

Opens the context menu for a header in this column tree or list tree, by column name.

void OpenHeaderContextMenu(string column)

Parameters

column string

The column name.

Remarks

After opening a context menu, you can use SelectMenuItemById(string) to select a menu item.

OpenHeaderContextMenu(uint)

Opens the context menu for a header in this column tree or list tree, by column index.

void OpenHeaderContextMenu(uint columnIndex)

Parameters

columnIndex uint

1-based.

Remarks

After opening a context menu, you can use SelectMenuItemById(string) to select a menu item.

PressEnter()

Presses the ENTER key.

void PressEnter()

Remarks

Set the focus to the tree item or node before invoking.

SelectMenuItemById(string)

Selects the specified menu item from a context menu in a tree.

void SelectMenuItemById(string menuItemId)

Parameters

menuItemId string

The SAP ID of the menu item in string format.

SelectNode(ITreeViewNode)

Selects the provided node in the tree.

void SelectNode(ITreeViewNode node)

Parameters

node ITreeViewNode

The node.

SelectNode(string)

Selects a node in the tree, by path.

void SelectNode(string path)

Parameters

path string

Nodes in the path can be specified by name or 1-based index in the format "#index".

Remarks

Use the BuildNodePath method to build the path argument.

You can use regular expressions for elements in the path. The format is: RegExp:=(regular expression).