TeScreen description properties

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

Property Name

Description

column count

The number of columns in the screen.

current column

The current column position of the cursor in the terminal emulator screen. The first column in the screen is 1.

current row

The current row position of the cursor in the terminal emulator screen. The first row in the screen is 1.

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.

Note: You can record on one terminal emulator session at a time.

input field count

The number of unprotected fields in the screen.

label

The logical name of the screen.

The value is determined by the location of the label area, which is defined by the values of the label column, label length, and label row properties. These properties are part of the TeScreen test object description and are therefore not available in the Object Identification dialog box. For details on the Object Identification Dialog Box, see the Micro Focus UFT One User Guide.

This property is useful when creating an object description, but it is not recommended for checkpoints because its value might be generated.

label column

The column position of the start of the label area. The first column in the screen is 1.

label length

The length of the label area.

label row

The row position of the label area. The first row in the screen is 1.

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.

protected field count

The number of protected (read-only) fields in the screen.

row count

The number of rows in the screen.

screen id

The unique identifier assigned to the screen object.

text

Content of the screen. Use the GetROProperty method to access this property.

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: