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

Common Method CaptureBitmapSaves a screen capture of the object as a .png or .bmp image, depending on the specified file extension.
Common Method CheckChecks whether the actual value of an item matches the expected value.
Common Method CheckPropertyChecks whether the specified object property achieves the specified value within the specified timeout.
Common Method ChildObjectsReturns the collection of child objects contained within the object.
Common Method GetAllROProperties

Returns the collection of properties and current values from the object in the application.

Common Method GetROPropertyReturns the current value of the specified description property from the object in the application.
Method GetThreadItemByIndexReturns the visible text of the thread item.
Common Method GetTOPropertiesReturns the collection of properties and values used to identify the object.
Common Method GetTOPropertyReturns the value of the specified description property from the test object description.
Common Method HighlightHighlights the object in the application.
Method GotoClicks a link in the threadbar object.
Method IsExistsIndicates whether the specified object exists.
Common Method OutputRetrieves the current value of an item and stores it in a specified location.
Common Method RefreshObjectInstructs UFT One to re-identify the object in the application the next time a step refers to this object.
Common Method SetTOPropertySets the value of the specified description property in the test object description.
Common Method ToStringReturns a string that represents the current test object.
Common Method WaitPropertyWaits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step.

Properties

Property ActiveThreadItemA data value representing the last clickable thread item (the most recent hyperlink) in the threadbar.
Property ClassNameThe class of the object.
Property CountThe number of objects of a given type that are present in the current context.
Common Property ExistChecks whether the object currently exists in the open application.
Property RepositoryNameThe name of the object as it is stored in the repository.
Property ThreadItemsA data value representing the entire threadbar.
Property UINameThe name of the object as it is appears in the user interface.

Back to top

 

GetThreadItemByIndex Method

Description

Returns the visible text of the thread item.

Syntax

object.GetThreadItemByIndex (Index)

Arguments

ParameterDescription
Index Required. A long integer value.
The index of the thread item in the Count property.

Return Type

A String value.

Example

Back to top

 

Goto Method

Description

Clicks a link in the threadbar object.

Syntax

object.Goto (ThreadbarLinkName)

Arguments

ParameterDescription
ThreadbarLinkName Required. A String value.
The name of the link.

Return Type

None.

Example

Back to top

 

IsExists Method

Description

Indicates whether the specified object exists.

Syntax

object.IsExists (ThreadbarLinkName)

Arguments

ParameterDescription
ThreadbarLinkName Required. A String value.
The visible title of the threadbar item.

Return Type

A long integer value.

Example

Back to top

 

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

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

 

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

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

 

ThreadItems Property

Description

A data value representing the entire threadbar.

Syntax

object.ThreadItems

Value Type

A String value.

Property type

Read-only property

Example

Back to top

 

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

Back to top

See also: