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
CaptureBitmap | Saves a screen capture of the object as a .png or .bmp image, depending on the specified file extension. |
Check | Checks whether the actual value of an item matches the expected value. |
CheckProperty | Checks whether the specified object property achieves the specified value within the specified timeout. |
ChildObjects | Returns the collection of child objects contained within the object. |
GetAllROProperties | Returns the collection of properties and current values from the object in the application. |
Collapse | Collapses a node in the tree view. |
Expand | Expands a node in the tree view. |
GetChildCount | Returns the number of child nodes of the tree item that are displayed on the current page. |
GetROProperty | Returns the current value of the specified description property from the object in the application. |
GetTOProperties | Returns the collection of properties and values used to identify the object. |
GetTOProperty | Returns the value of the specified description property from the test object description. |
Highlight | Highlights the object in the application. |
GetTreeItemName | Returns the visible text of the specified tree item. |
IsExists | Indicates whether the specified object exists (TRUE) or does not exist (FALSE). |
IsExpanded | Indicates whether the specified tree node is expanded (TRUE) or collapsed (FALSE). |
NextPage | Scrolls the tree view to the next page. |
Output | Retrieves the current value of an item and stores it in a specified location. |
PreviousPage | Scrolls the tree view to the previous page. |
RefreshObject | Instructs UFT One to re-identify the object in the application the next time a step refers to this object. |
Select | Selects a node in the tree view. |
SetTOProperty | Sets the value of the specified description property in the test object description. |
ToString | Returns a string that represents the current test object. |
WaitProperty | Waits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step. |
Properties
ActiveTreeItem | A data item representing the visible text of the current tree item. |
ClassName | The class of the object. |
Exist | Checks whether the object currently exists in the open application. |
RepositoryName | The name of the object as it is stored in the repository. |
UIName | The name of the object as it appears in the user interface. |
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
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
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
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
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
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
NextPage Method
Description
Scrolls the tree view to the next page.
Syntax
object.NextPage
Return Type
None.
Example
PreviousPage Method
Description
Scrolls the tree view to the previous page.
Syntax
object.PreviousPage
Return Type
None.
Example
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
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
ClassName Property
Description
The class of the object.
Syntax
object.ClassName
Value Type
A String value.
Property type
Read-only property
Example
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
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
See also:
- SblAdvancedEdit
- SblButton
- SblCheckBox
- SblEdit
- SblPickList
- SblTable
- SblTabStrip
- SblTreeView
- SiebApplet
- SiebApplication
- SiebButton
- SiebCalculator
- SiebCalendar
- SiebCheckbox
- SiebCommunicationsToolbar
- SiebCurrency
- SiebInkData
- SiebList
- SiebMenu
- SiebPageTabs
- SiebPDQ
- SiebPicklist
- SiebRichText
- SiebScreen
- SiebScreenViews
- SiebTask
- SiebTaskAssistant
- SiebTaskLink
- SiebTaskStep
- SiebTaskUIPane
- SiebText
- SiebTextArea
- SiebThreadbar
- SiebToolbar
- SiebTree
- SiebView
- SiebViewApplets