SiebButton Object

Description

A button control 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 SiebButton object.

Note: You can also view a list and descriptions of the SiebButton 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.

Method ClickClicks the button.
Common Method GetROPropertyReturns the current value of the specified description property from the object in the application.
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.
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 ClassNameThe class of the object.
Common Property ExistChecks whether the object currently exists in the open application.
Property IsEnabledIndicates whether the object is enabled.
Property RepositoryNameThe name of the object as it is stored in the repository.
Property UINameThe name of the object as it appears in the user interface.

Back to top

 

Click Method

Description

Clicks the button.

Syntax

object.Click

Return Type

None.

Example

 'The following example uses the Click method to perform a query, and then
'if exactly one record is returned from the query, the record is deleted.

SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebButton("Query").Click
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebText("Opportunity Name").SetText "My Opportunity"
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebButton("Go").Click
'Verify that the record exists in the list - there is one list record , if yes - delete the record
var_RowsCount = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunities").SiebList("List").RowsCount
If var_RowsCount = 1 Then
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebButton("Delete").Click
    Browser("Siebel Call Center").Dialog("Siebel").WinButton("OK").Click
End If

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

                    '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

 

IsEnabled Property

Description

Indicates whether the object is enabled.

Syntax

object.IsEnabled

Value Type

A long integer value.

Property type

Read-only property

Example

                    'The following example uses the IsEnabled property to ensure that the
'"Query" button is enabled before clicking it.

var_IsEnabled = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebButton("Query").IsEnabled
If var_IsEnabled Then
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebButton("Query").Click
End If

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

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

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

                    '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

Back to top

See also: