TeField description properties

The TeField test object supports the description properties listed in the table below.

Property Name

Description

attached text

The static text located near the field. This property is useful when creating an object description but should not be used for checkpoints.

Note: If no text is found near the field, UFT One generates a unique identifier. For example, the property might be, field3156, where 3156 is the internally generated unique identifier.

field id

The unique identifier assigned to the field object.

index

The ordinal identifier that UFT One assigns to the object to indicate the order in which the object appears relative to other objects with an otherwise identical description. The property can be useful for uniquely identifying an object using programmatic descriptions. This property cannot be used with GetROProperty.

Values begin with 0.

length

The length of the field in characters.

location

The ordinal identifier that UFT One assigns to the object to indicate where the object appears within the window, frame, or dialog box. Values are assigned from top to bottom, and left to right. This property cannot be used with GetROProperty.

Values begin with 0.

numeric

Indicates whether the field is numeric only.

Possible values:     
        True
        False

protected

Indicates whether the field is protected (read-only).

Possible values:     
        True
        False

start column

Column number of the first character in the field. The first column in the screen is 1.

start row

Row number of the first character in the field. The first row in the screen is 1.

text

Content of the field.

visible

Indicates whether the contents of the field are visible.

Possible values:
        True
        False

visual relations

Represents the test object's visual relations identifier.

Use this property in GetTOProperty and SetTOProperty steps to return or apply a VisualRelationsCollection object for a test object. The VisualRelationsCollection object enables you to retrieve or replace the visual relation identifier settings of a test object during a run session.

Syntax:

SetVRIColl = TestObject.GetTOProperty("visual relations")

TestObject.SetTOProperty "visual relations", VRIColl

For details, see VisualRelationsCollection Object in the Utility section of the Object Model Reference.

This property is not listed in the Object Spy. It is not retrieved when you use the GetTOProperties method. It cannot be used in the Object Identification dialog box, the description area of the object repository, checkpoint or output value steps, and so on.

See also: