SiebThreadbar Object
Description
A threadbar 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 SiebThreadbar object.
Note: You can also view a list and descriptions of the SiebThreadbar 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. |
GetROProperty | Returns the current value of the specified description property from the object in the application. |
GetThreadItemByIndex | Returns the visible text of the thread item. |
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. |
Goto | Clicks a link in the threadbar object. |
IsExists | Indicates whether the specified object exists. |
Output | Retrieves the current value of an item and stores it in a specified location. |
RefreshObject | Instructs UFT One to re-identify the object in the application the next time a step refers to this object. |
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
ActiveThreadItem | A data value representing the last clickable thread item (the most recent hyperlink) in the threadbar. |
ClassName | The class of the object. |
Count | The number of objects of a given type that are present in the current context. |
Exist | Checks whether the object currently exists in the open application. |
RepositoryName | The name of the object as it is stored in the repository. |
ThreadItems | A data value representing the entire threadbar. |
UIName | The name of the object as it is appears in the user interface. |
GetThreadItemByIndex Method
Description
Returns the visible text of the thread item.
Syntax
object.GetThreadItemByIndex (Index)
Arguments
Parameter | Description |
---|---|
Index |
Required. A long integer value. The index of the thread item in the Count property. |
Return Type
A String value.
Example
'The following example uses the GetThreadItemByIndex method to enumerate 'through the items in a threadbar until the item with the text '"Contact Detail" is located. var_count = SiebApplication("Siebel Call Center").SiebScreen("Activities").SiebThreadbar("Threadbar").Count For i = 0 To var_count var_ThreadBarItem = SiebApplication("Siebel Call Center").SiebScreen("Activities").SiebThreadbar("Threadbar").GetThreadItemByIndex(i) If InStr(1, var_ThreadBarItem, "Contact Detail", 1) Then SiebApplication("Siebel Call Center").SiebScreen("Activities").SiebThreadbar("Threadbar").Goto var_ThreadBarItem Exit For End If Next
Goto Method
Description
Clicks a link in the threadbar object.
Syntax
object.Goto (ThreadbarLinkName)
Arguments
Parameter | Description |
---|---|
ThreadbarLinkName |
Required. A String value. The name of the link. |
Return Type
None.
Example
'The following example uses the Goto method to return to the page 'immediately preceding the currently displayed page. var_PrevItem = SiebApplication("Siebel Call Center").SiebScreen("Activities").SiebThreadbar("Threadbar").ActiveThreadItem SiebApplication("Siebel Call Center").SiebScreen("Activities").SiebThreadbar("Threadbar").Goto var_PrevItem
IsExists Method
Description
Indicates whether the specified object exists.
Syntax
object.IsExists (ThreadbarLinkName)
Arguments
Parameter | Description |
---|---|
ThreadbarLinkName |
Required. A String value. The visible title of the threadbar item. |
Return Type
A long integer value.
Example
'The following example checks whether the specified link exists in the threadbar, 'and navigates to it if it exists. If SiebApplication("Siebel Call Center").SiebScreen("Products").SiebThreadbar("Threadbar").IsExists("All Order Line Items Analysis View (Sales)0") Then SiebApplication("Siebel Call Center").SiebScreen("Products").SiebThreadbar("Threadbar").Goto "All Order Line Items Analysis View (Sales)0" End If
ActiveThreadItem Property
Description
A data value representing the last clickable thread item (the most recent hyperlink) in the threadbar.
Syntax
object.ActiveThreadItem
Value Type
A String value.
Property type
Read-only property
Example
'The following example uses the ActiveThreadItem property to locate the 'currently active page, and return to the page immediately preceding it. var_PrevItem = SiebApplication("Siebel Call Center").SiebScreen("Activities").SiebThreadbar("Threadbar").ActiveThreadItem SiebApplication("Siebel Call Center").SiebScreen("Activities").SiebThreadbar("Threadbar").Goto var_PrevItem
ClassName Property
Description
The class of the object.
Syntax
object.ClassName
Value Type
A String value.
Property type
Read-only property
Example
'The following example uses the UIName and ClassName properties to display this 'information for all child objects of the Siebel Call Center application. 'Retrieve all the children of the siebel application object Set MyDescription = Description.Create() Set MyChildren = SiebApplication("Siebel Call Center").ChildObjects(MyDescription) childCount = MyChildren.Count 'Display the UI names and classes for each object. For i = 0 To childCount - 1 MsgBox MyChildren(i).UIName + " object of class " + MyChildren(i).ClassName Next
Count Property
Description
The number of objects of a given type that are present in the current context.
Syntax
object.Count
Value Type
A long integer value.
Property type
Read-only property
Example
'The following example uses the Count property to find the total number 'of items in the threadbar and enumerates through them until it find the '"Contact Details" item. var_count = SiebApplication("Siebel Call Center").SiebScreen("Activities").SiebThreadbar("Threadbar").Count For i = 0 To var_count var_ThreadBarItem = SiebApplication("Siebel Call Center").SiebScreen("Activities").SiebThreadbar("Threadbar").GetThreadItemByIndex(i) If InStr(1, var_ThreadBarItem, "Contact Detail", 1) Then SiebApplication("Siebel Call Center").SiebScreen("Activities").SiebThreadbar("Threadbar").Goto var_ThreadBarItem Exit For End If Next
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
ThreadItems Property
Description
A data value representing the entire threadbar.
Syntax
object.ThreadItems
Value Type
A String value.
Property type
Read-only property
Example
'The following example uses the ThreadItems property to locate the first '"Contact Detail" page in the current session, by retrieving all 'threadbar items as strings, splitting each string to an array, and 'checking whether each item in the array is the "Contact Detail" page. var_items = SiebApplication("Siebel Call Center").SiebScreen("Activities").SiebThreadbar("Threadbar").ThreadItems Dim ItemsArray ItemsArray = Split(var_items, "|") For Each ThreadBarItem In ItemsArray If InStr(1, ThreadBarItem, "Contact Detail", 1) Then SiebApplication("Siebel Call Center").SiebScreen("Activities").SiebThreadbar("Threadbar").Goto ThreadBarItem Exit For End If Next
UIName Property
Description
The name of the object as it is appears in the user interface.
Syntax
object.UIName
Value Type
A String value.
Property type
Read-only property
Example
'The following example finds all the objects in the Daily Calendar with the same 'classname as a specified SiebPickList object and then displays the Repository 'name of each of these objects. Set MyDescription = Description.Create() MyDescription("classname").Value = SiebApplication("Siebel Call Center").SiebScreen("Home").SiebView("Siebel Web Call Center").SiebApplet("Daily Calendar").SiebPicklist("SiebPicklist").ClassName Set MyChildren = SiebApplication("Siebel Call Center").SiebScreen("Home").SiebView("Siebel Web Call Center").SiebApplet("Daily Calendar").ChildObjects(MyDescription) childCount = MyChildren.Count ' now we show test object names For i = 0 To childCount - 1 MsgBox MyChildren(i).RepositoryName Next
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