VirtualButton Object

Description

An object mapped to the virtual button class.

Methods

Method ClickClicks on a virtual object.
Method DblClickDouble-clicks on an object.
ExistChecks that an object exists.
GetTOPropertyReturns the value of the specified description property from the test object description.
SetTOPropertySets the specified value of an description properties for an object.
ToStringReturns a string that represents the current test object.

Back to top

Click Method

Description

Clicks on a virtual object.

Syntax

VirtualButton.Click

The following example clicks the Open button.

                        Browser("Demo of Vo Object").Page("Demo of Vo Object").ActiveX("VoDemoForm").VirtualButton("Open").Click

Back to top

DblClick Method

Description

Double-clicks on an object.

Syntax

VirtualButton.DblClick

The following example double-clicks the Find button.

                        Browser("Demo of Vo Object").Page("Demo of Vo Object").ActiveX("VoDemoForm").VirtualButton("Find").DblClick

Back to top

Exist Property

Description

Checks that an object exists.

Syntax

VirtualButton.Exist([Timeout])

Argument

Type

Description

Timeout

Number

Optional. The length of time to search for the object before returning a True or False value.

  • If a timeout value is specified, UFT One waits until it finds the object or until the timeout is reached.

  • If the value 0 is specified, the method returns the True or False value immediately.

  • If no value is specified, the value specified in the Test Settings dialog box for the Object Synchronization Timeout is used for tests.

For more details on the Object Synchronization Timeout, see the UFT One User Guide.

Return Value

Boolean

The following example uses the Exist property to determine the existence of the Open button. If the object exists a message box opens confirming its appearance.

                        If Browser("Demo of Vo Object").Page("Demo of Vo Object").ActiveX("VoDemoForm").VirtualButton("Open").Exist Then
msgbox("The object exists.") 
End If

Back to top

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 UFT One User Guide.

Syntax

VirtualButton.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 Size property of the Open button.

                        ObjectName = Browser("Demo of Vo Object").Page("Demo of Vo Object").ActiveX("VoDemoForm").VirtualButton("Open").GetTOProperty("Size")

Back to top

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

VirtualButton.GetTOProperty(Property)

Argument

Type

Description

Property

String

The description properties whose value is retrieved from the object description.

The following example uses the SetTOProperty method to set the value of the Open button test object's Size property during the test run.

                        Browser("Demo of Vo Object").Page("Demo of Vo Object").ActiveX("VoDemoForm").VirtualButton("Open").SetTOProperty "Size",6

Back to top

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

VirtualButton.ToString

Return Value

A String value. The name of the test object and its generic type, for example, MyButton VirtualButton.

The following example uses the ToString method to generate a report detailing the dimensions of a VirtualButton 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").VirtualButton("OK")

Back to top