SiebCalculator Object

Description

A calculator 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 SiebCalculator object.

Note: You can also view a list and descriptions of the SiebCalculator 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 ClickKeyClicks a key in the calculator popup applet.
Method ClickKeysClicks keys in the open calculator popup applet.
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.
Method OpenPopupOpens the calculator popup applet.
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.
Method SetTextEnters text in the textbox.
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 IsOpenIndicates whether the associated popup applet is open.
Property IsRequiredIndicates whether the object is required.
Property RepositoryNameThe name of the object as it is stored in the repository.
Property TextThe text value of the object.
Property UINameThe name of the object as it appears in the user interface.

Back to top

 

ClickKey Method

Description

Clicks a key in the calculator popup applet.

Syntax

object.ClickKey (Key)

Arguments

ParameterDescription
Key Required. A String value.
The key to click. This method is valid only when the calculator popup applet is open.

Return Type

None.

Example

                    'The following example uses the ClickKey method to enter several individual
'number keys in the "Amount" calculator.

    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCurrency("Revenue").SiebCalculator("Amount").OpenPopup
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCurrency("Revenue").SiebCalculator("Amount").ClickKeys "11"
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCurrency("Revenue").SiebCalculator("Amount").ClickKey "0"
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCurrency("Revenue").SiebCalculator("Amount").ClickKey "0"
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCurrency("Revenue").SiebCalculator("Amount").ClickKey "0"
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCurrency("Revenue").SiebCalculator("Amount").ClickKey "0"
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCurrency("Revenue").SiebCalculator("Amount").ClickKey "="

Back to top

 

ClickKeys Method

Description

Clicks keys in the open calculator popup applet.

Syntax

object.ClickKeys (Keys)

Arguments

ParameterDescription
Keys Required. A String value.
The keys to be clicked.

Return Type

None.

Example

                    'The following example uses the ClickKeys method to enter a series of keys
'into the "Amount" calculator.

    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCurrency("Revenue").SiebCalculator("Amount").OpenPopup
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCurrency("Revenue").SiebCalculator("Amount").ClickKeys "11"
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCurrency("Revenue").SiebCalculator("Amount").ClickKey "0"
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCurrency("Revenue").SiebCalculator("Amount").ClickKey "0"
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCurrency("Revenue").SiebCalculator("Amount").ClickKey "0"
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCurrency("Revenue").SiebCalculator("Amount").ClickKey "0"
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCurrency("Revenue").SiebCalculator("Amount").ClickKey "="

Back to top

 

OpenPopup Method

Description

Opens the calculator popup applet.

Syntax

object.OpenPopup

Return Type

None.

Example

                    'The following example uses the OpenPopup method to open the "Amount"
'calculator after confirming that the Currency calculator contains the
'proper calculator control.

var_GetClassCount = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCurrency("Revenue").GetClassCount("SiebCalculator")
var_GetRepositoryName = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCurrency("Revenue").GetRepositoryName("SiebCalculator", "Amount")
If (var_GetClassCount = 1 And var_GetRepositoryName = "Amount") Then
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCurrency("Revenue").SiebCalculator("Amount").OpenPopup
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCurrency("Revenue").SiebCalculator("Amount").ClickKeys "11"
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCurrency("Revenue").SiebCalculator("Amount").ClickKey "0"
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCurrency("Revenue").SiebCalculator("Amount").ClickKey "0"
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCurrency("Revenue").SiebCalculator("Amount").ClickKey "0"
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCurrency("Revenue").SiebCalculator("Amount").ClickKey "0"
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCurrency("Revenue").SiebCalculator("Amount").ClickKey "="
End If

Back to top

 

SetText Method

Description

Enters text in the textbox.

Syntax

object.SetText (Text)

Arguments

ParameterDescription
Text Required. A String value.
The text to enter in the textbox.

Return Type

None.

Example

                    'The following example uses the SetText method to enter text in a
'calculator control after ensuring that it is enabled.

var_IsEnabled = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCurrency("Revenue").SiebCalculator("Amount").IsEnabled
If var_IsEnabled Then
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCurrency("Revenue").SiebCalculator("Amount").SetText "1234"
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
'"Amount" calculator is enabled before entering a value in the calculator.

var_IsEnabled = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCurrency("Revenue").SiebCalculator("Amount").IsEnabled
If var_IsEnabled Then
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCurrency("Revenue").SiebCalculator("Amount").SetText "1234"
End If

Back to top

 

IsOpen Property

Description

Indicates whether the associated popup applet is open.

Syntax

object.IsOpen

Value Type

A long integer value.

Property type

Read-only property

Example

                    'The following example uses the IsOpen property to check whether the
'"Amount" calculator pop-up object is already open, and if not, opens it.

var_IsOpen = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCurrency("Revenue").SiebCalculator("Amount").IsOpen
If Not var_IsOpen Then
var_GetRepositoryNameByIndex = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCurrency("Revenue").GetRepositoryNameByIndex("SiebCalculator", 0)
    If var_GetRepositoryNameByIndex = "Amount" Then
        SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCurrency("Revenue").SiebCalculator("Amount").OpenPopup
    End If
End If

Back to top

 

IsRequired Property

Description

Indicates whether the object is required.

Syntax

object.IsRequired

Value Type

A long integer value.

Property type

Read-only property

Example

                    'The following example uses the IsRequired property to check whether the
'"Amount" calculator is set as a required field and then attempts to enter
'an empty string in it.  The example then confirms that a warning message
'opens when submitting an empty string in the required field.

var_IsRequired = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCurrency("Revenue").SiebCalculator("Amount").IsRequired
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCurrency("Revenue").SiebCalculator("Amount").SetText ""
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebButton("New").Click
var_Exist = Browser("Siebel Call Center").Dialog("Siebel").Exist
If (var_IsRequired And var_Exist) Then
    Reporter.ReportEvent 0, "SiebCurrency object   ", "behaves as expected for a required field."
Else
   Reporter.ReportEvent 1, "SiebCurrency object   ", "does not behave properly as a required field."
End If
Browser("Siebel Call Center").Dialog("Siebel").WinButton("OK").Click

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

 

Text Property

Description

The text value of the object.

Syntax

object.Text

Value Type

A String value.

Property type

Read-only property

Example

                    'The following example uses the Text property to confirm that the
'calculated value of a multiplication operation is correct.

a = "7"
b = "4"
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCurrency("Revenue").SiebCalculator("Amount").ClickKey a
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCurrency("Revenue").SiebCalculator("Amount").ClickKey "*"
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCurrency("Revenue").SiebCalculator("Amount").ClickKey b
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCurrency("Revenue").SiebCalculator("Amount").ClickKey "="
If SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCurrency("Revenue").SiebCalculator("Amount").Text = (a * b) & ".00" Then
    MsgBox ("The calculator performed a successful multiplication operation.")
Else
    MsgBox ("The calculation is incorrect.")
End If

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: