Description

The task step 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 SiebTaskStep object.

Note: You can also view a list and descriptions of the SiebTaskStep 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.
GetClassCount	Returns the number of objects of the specified type.
GetRepositoryName	Returns the RepositoryName of the object.
GetRepositoryNameByIndex	Returns the RepositoryName of the item with the specified index.
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.
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

ActiveApplet	The RepositoryName of the active Applet object.
AppletCount	The number of applets under the current view.
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.
TaskStepTitle	The StepTitle for the TaskView.
TaskViewTitle	The title for the TaskView.
UIName	The name of the object as it appears in the user interface.

Back to top

GetClassCount Method

Description

Returns the number of objects of the specified type.

Syntax

object.GetClassCount (ClassName)

Arguments

Return Type

A long integer value.

Back to top

GetRepositoryName Method

Description

Returns the RepositoryName of the object.

Syntax

object.GetRepositoryName (ClassName, UIName)

Arguments

Return Type

A String value.

The repository name of the specified child object.

IMPORTANT

The specified object must be a direct child object of the SiebTaskStep object.

Back to top

GetRepositoryNameByIndex Method

Description

Returns the RepositoryName of the item with the specified index.

Syntax

object.GetRepositoryNameByIndex (ClassName, Index)

Arguments

Return Type

A String value.

Back to top

ActiveApplet Property

Description

The RepositoryName of the active Applet object.

Syntax

object.ActiveApplet

Value Type

A String value.

Property type

Read-only property

Back to top

AppletCount Property

Description

The number of applets under the current view.

Syntax

object.AppletCount

Value Type

A long integer value.

Property type

Read-only property

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

Display the UI Names and Classes for Child Objects (VBScript)

                    '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

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

TaskStepTitle Property

Description

The StepTitle for the TaskView.

Syntax

object.TaskStepTitle

Value Type

A String value.

Property type

Read-only property

Back to top

TaskViewTitle Property

Description

The title for the TaskView.

Syntax

object.TaskViewTitle

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

Back to top

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