Object Model Reference for GUI Testing > Supplemental Objects > Exist Property

VirtualCheckBox Object

Description

An object mapped to the virtual check box class.

Methods

Method Exist Checks that an object exists.
Method GetTOProperty Returns the value of a specified description properties for a test object. 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.

Back to top

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.

  • If a timeout value is specified, UFT 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 HPE Unified Functional Testing User Guide.

Return Value

Boolean


Back to top

GetTOProperty Method

Description

Returns the value of a specified description properties for a test object. 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 HPE Unified 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


Back to top

Set Method

Description

Toggles the check box state.

Syntax

VirtualCheckBox.Set Value

Argument

Type

Description

Value

String

Always TOGGLE.


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

VirtualCheckBox.SetTOProperty Property, Value

Argument

Type

Description

Property

String

The description properties to set.

Value

Variant

The value to assign to the listed property.


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

VirtualCheckBox.ToString

Return Value

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


Back to top