SiebCheckbox Object

Description

A checkbox 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 SiebCheckbox object.

Note: You can also view a list and descriptions of the SiebCheckbox 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.
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.
Method SetOffSets the state of the checkbox to not checked.
Method SetOnSets the state of the checkbox to checked.
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 IsCheckedIndicates whether the checkbox is checked.
Property IsEnabledIndicates whether the object is enabled.
Property IsRequiredIndicates whether the object is required.
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

 

SetOff Method

Description

Sets the state of the checkbox to not checked.

Syntax

object.SetOff

Return Type

None.

Example

                    'The following example uses the SetOff method to clear the "Committed"
'check box after checking that the check box is already checked and enabled.

SiebApplication("Siebel Call Center").SiebPageTabs("PageTabs").GotoScreen "Opportunities Screen"
SiebApplication("Siebel Call Center").SiebPageTabs("PageTabs").GotoView "Opportunity List View"
var_IsEnabled = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCheckbox("Committed").IsEnabled()
var_IsChecked = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCheckbox("Committed").IsChecked()
If var_IsChecked And var_IsEnabled Then
 SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCheckbox("Committed").SetOff
End If

Back to top

 

SetOn Method

Description

Sets the state of the checkbox to checked.

Syntax

object.SetOn

Return Type

None.

Example

                    'The following example uses the SetOn method to select the "Committed"
'check box after checking that the check box is cleared and enabled.

var_IsEnabled = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCheckbox("Committed").IsEnabled()
var_IsChecked = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCheckbox("Committed").IsChecked()
If (Not var_IsChecked) And var_IsEnabled Then
 SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCheckbox("Committed").SetOn
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

 

IsChecked Property

Description

Indicates whether the checkbox is checked.

Syntax

object.IsChecked

Value Type

A long integer value.

Property type

Read-only property

Example

                    'The following example uses the IsChecked property to check whether the
'"Committed" check box is selected and enabled, and then clears it.

SiebApplication("Siebel Call Center").SiebPageTabs("PageTabs").GotoScreen "Opportunities Screen"
SiebApplication("Siebel Call Center").SiebPageTabs("PageTabs").GotoView "Opportunity List View"
var_IsEnabled = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCheckbox("Committed").IsEnabled()
var_IsChecked = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCheckbox("Committed").IsChecked()
If var_IsChecked And var_IsEnabled Then
 SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCheckbox("Committed").SetOff
End If

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 checks whether the "Committed" check box is enabled,
'required, and is currently not checked. If so it selects it.

SiebApplication("Siebel Call Center").SiebPageTabs("PageTabs").GotoScreen "Opportunities Screen"
SiebApplication("Siebel Call Center").SiebPageTabs("PageTabs").GotoView "Opportunity List View"
var_IsEnabled = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCheckbox("Committed").IsEnabled()
var_IsChecked = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCheckbox("Committed").IsChecked()
var_IsRequired = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCheckbox("Committed").IsChecked()
If var_IsEnabled And var_IsRequired And Not var_IsChecked Then
 SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCheckbox("Committed").SetOn
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 checks whether the "Committed" check box is enabled,
'required, and is currently not checked. If so it selects it.

SiebApplication("Siebel Call Center").SiebPageTabs("PageTabs").GotoScreen "Opportunities Screen"
SiebApplication("Siebel Call Center").SiebPageTabs("PageTabs").GotoView "Opportunity List View"
var_IsEnabled = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCheckbox("Committed").IsEnabled()
var_IsChecked = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCheckbox("Committed").IsChecked()
var_IsRequired = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCheckbox("Committed").IsChecked()
If var_IsEnabled And var_IsRequired And Not var_IsChecked Then
 SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("My Opportunities").SiebApplet("Opportunity").SiebCheckbox("Committed").SetOn
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

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: