VirtualCheckBox Object
Description
An object mapped to the virtual check box class.
Methods
Exist | Checks that an object exists. |
GetTOProperty | Returns the value of the specified description property from the test object description. The value is taken from the Object Repository. |
Set | Toggles the check box state. |
SetTOProperty | Sets the specified value of an description properties for an object. |
ToString | Returns a string that represents the current test object. |
Exist Property
Description
Checks that an object exists.
Syntax
VirtualCheckBox.Exist([Timeout])
Argument | Type | Description |
---|---|---|
Timeout | Number | Optional. The length of time to search for the object before returning a True or False value.
For more details on the Object Synchronization Timeout, see the OpenText Functional Testing User Guide. |
Return Value
Boolean
The following example uses the Exist property to determine the existence of the Underline check box. If the object exists a message box is displayed confirming its appearance.
If Browser("Demo of Vo Object").Page("Demo of Vo Object").ActiveX("VoDemoForm").VirtualCheckBox("Underline").Exist Then
msgbox("The object exists.")
End If
GetTOProperty Method
Description
Returns the value of the specified description property from the test object description. The value is taken from the Object Repository.
Note: You can use the GetTOProperty method to retrieve the values of only those properties that are included in the test object description. Specifying a property that is not included in the test object's description results in a warning status for the step and the test. For more details on adding properties to a test object description, see the OpenText Functional Testing User Guide.
Syntax
VirtualCheckBox.GetTOProperty(Property)
Argument | Type | Description |
---|---|---|
Property | String | The description properties whose value is retrieved from the object description. |
Return Value
Variant
The following example uses the GetTOProperty method to retrieve the State property of the Underline check box.
Dim ObjectState
ObjectState = Browser("Demo of Vo Object").Page("Demo of VoObject").ActiveX("VoDemoForm").VirtualCheckBox("Underline").GetTOProperty("State")
Set Method
Description
Toggles the check box state.
Syntax
VirtualCheckBox.Set Value
Argument | Type | Description |
---|---|---|
Value | String | Always |
The following example toggles the Underline check box (from ON to OFF or the reverse).
Browser("Demo of Vo Object").Page("Demo of Vo Object").ActiveX("VoDemoForm").VirtualCheckBox("Underline").Set"TOGGLE"
SetTOProperty Method
Description
Sets the specified value of an description properties for an object.
Note: SetTOProperty changes the properties used to identify an object during run-time. It has no effect on the Active Screen or the values saved in the Object Repository for the object.
Syntax
VirtualCheckBox.SetTOProperty Property, Value
Argument | Type | Description |
---|---|---|
Property | String | The description properties to set. |
Value | Variant | The value to assign to the listed property. |
The following example uses the SetTOProperty method to set the value of the Underline check box test object's State property during the test run.
Browser("Demo of Vo Object").Page("Demo of Vo Object").ActiveX("VoDemoForm").VirtualCheckBox("Underline").SetTOProperty "State", 0
ToString Method
Description
Returns a string that represents the current test object.
Tip: The ToString method is useful if you want to retrieve the test object name and type from within a function or keyword.
Syntax
VirtualCheckBox.ToString
Return Value
A String value. The name of the test object and its generic type, for example, MyCheckBox VirtualCheckBox
.
The following example uses the ToString method to generate a report detailing the dimensions of a VirtualCheckBox test object.
Sub ReportRectangle(obj)
x = obj.GetTOProperty("x")
y = obj.GetTOProperty("y")
w = obj.GetTOProperty("width")
h = obj.GetTOProperty("height")
Reporter.ReportEvent micDone, obj.ToString() & " dimensions", "The Virtual object " & obj.ToString() & " is defined using the following dimensions: " & x & ", " & y & ", " & x+w & ", " & y+h
End Sub
'Sample usage
ReportRectangle Window("Form3").VirtualCheckBox("CheckBox1")