Object Model Reference for GUI Testing > Siebel > Collapse Method

SiebTree Object

Description

A tree view object in a Siebel test automation environment.

Operations

The sections below list the built-in methods and properties that you can use as operations for the SiebTree object.

Note: You can also view a list and descriptions of the SiebTree description properties, for use in object repository descriptions, programmatic descriptions, checkpoint and output value steps, and as argument values for the GetTOProperty and GetROProperty methods.

Methods

Common Method CaptureBitmap Saves a screen capture of the object as a .png or .bmp image, depending on the specified file extension.
Common Method Check Checks whether the actual value of an item matches the expected value.
Common Method CheckProperty Checks whether the specified object property achieves the specified value within the specified timeout.
Common Method ChildObjects Returns the collection of child objects contained within the object.
Method Collapse Collapses a node in the tree view.
Method Expand Expands a node in the tree view.
Method GetChildCount Returns the number of child nodes of the tree item that are displayed on the current page.
Common Method GetROProperty Returns the current value of the specified description properties from the object in the application.
Common Method GetTOProperties Returns the collection of properties and values used to identify the object.
Common Method GetTOProperty Returns the value of the specified description properties from the test object description.
Method GetTreeItemName Returns the visible text of the specified tree item.
Method IsExists Indicates whether the specified object exists (TRUE) or does not exist (FALSE).
Method IsExpanded Indicates whether the specified tree node is expanded (TRUE) or collapsed (FALSE).
Method NextPage Scrolls the tree view to the next page.
Common Method Output Retrieves the current value of an item and stores it in a specified location.
Method PreviousPage Scrolls the tree view to the previous page.
Common Method RefreshObject Instructs UFT to re-identify the object in the application the next time a step refers to this object.
Method Select Selects a node in the tree view.
Common Method SetTOProperty Sets the value of the specified description properties in the test object description.
Common Method ToString Returns a string that represents the current test object.
Common Method WaitProperty Waits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step.

Properties

Property ActiveTreeItem A data item representing the visible text of the current tree item.
Property ClassName The class of the object.
Common Property Exist Checks whether the object currently exists in the open application.
Property RepositoryName The name of the object as it is stored in the repository.
Property UIName The name of the object as it appears in the user interface.

 

Back to top

Collapse Method

Description

Collapses a node in the tree view.

Syntax

object.Collapse (Position)

Arguments

Parameter Description
Position Required. A String value.
The position of the node in the tree, in the format:
first-level-position.second-level-position.third-level-position
where each position is in relation to its current context within the preceding level. For example, 1.3.2 represents the second node within the third node of the first root node.

Return Type

None.

Example


 

Back to top

Expand Method

Description

Expands a node in the tree view.

Syntax

object.Expand (Position)

Arguments

Parameter Description
Position Required. A String value.
The position of the node in the tree, in the format:
first-level-position.second-level-position.third-level-position
where each position is in relation to its current context within the preceding level. For example, 1.3.2 represents the second node within the third node of the first root node.

Return Type

None.

Example


 

Back to top

GetChildCount Method

Description

Returns the number of child nodes of the tree item that are displayed on the current page.

Syntax

object.GetChildCount (Position)

Arguments

Parameter Description
Position Required. A String value.
The position of the node in the tree, in the format:
first-level-position.second-level-position.third-level-position
where each position is in relation to its current context within the preceding level. For example, 1.3.2 represents the second node within the third node of the first root node.

Return Type

A long integer value.

Example


 

Back to top

GetTreeItemName Method

Description

Returns the visible text of the specified tree item.

Syntax

object.GetTreeItemName (Position)

Arguments

Parameter Description
Position Required. A String value.
The position of the node in the tree, in the format:
first-level-position.second-level-position.third-level-position
where each position is in relation to its current context within the preceding level. For example, 1.3.2 represents the second node within the third node of the first root node.

Return Type

A String value.

Example


 

Back to top

IsExists Method

Description

Indicates whether the specified object exists (TRUE) or does not exist (FALSE).

Syntax

object.IsExists (Position)

Arguments

Parameter Description
Position Required. A String value.
The position of the node in the tree, in the format:
first-level-position.second-level-position.third-level-position
where each position is in relation to its current context within the preceding level. For example, 1.3.2 represents the second node within the third node of the first root node.

Return Type

A String value.

Example


 

Back to top

IsExpanded Method

Description

Indicates whether the specified tree node is expanded (TRUE) or collapsed (FALSE).

Syntax

object.IsExpanded (Position)

Arguments

Parameter Description
Position Required. A String value.
The position of the node in the tree, in the format:
first-level-position.second-level-position.third-level-position
where each position is in relation to its current context within the preceding level. For example, 1.3.2 represents the second node within the third node of the first root node.

Return Type

A String value.

Example


 

Back to top

NextPage Method

Description

Scrolls the tree view to the next page.

Syntax

object.NextPage

Return Type

None.

Example


 

Back to top

PreviousPage Method

Description

Scrolls the tree view to the previous page.

Syntax

object.PreviousPage

Return Type

None.

Example


 

Back to top

Select Method

Description

Selects a node in the tree view.

Syntax

object.Select (Position)

Arguments

Parameter Description
Position Required. A String value.
The position of the node in the tree, in the format:
first-level-position.second-level-position.third-level-position
where each position is in relation to its current context within the preceding level. For example, 1.3.2 represents the second node within the third node of the first root node.

Return Type

None.

Example


 

Back to top

ActiveTreeItem Property

Description

A data item representing the visible text of the current tree item.

Syntax

object.ActiveTreeItem

Value Type

A String value.

Property type

Read-only property

Example


 

Back to top

ClassName Property

Description

The class of the object.

Syntax

object.ClassName

Value Type

A String value.

Property type

Read-only property

Example


 

Back to top

RepositoryName Property

Description

The name of the object as it is stored in the repository.

Syntax

object.RepositoryName

Value Type

A String value.

Property type

Read-only property


 

Back to top

UIName Property

Description

The name of the object as it appears in the user interface.

Syntax

object.UIName

Value Type

A String value.

Property type

Read-only property

Example


Back to top

See also: