TeField Object

Description

A terminal emulator field that fully supports HLLAPI.

IMPORTANT

The TeField object includes both unprotected fields, which can receive input, and protected fields, which contain fixed text.

Operations

The sections below list the built-in methods and properties that you can use as operations for the TeField object.

Note: You can also view a list and descriptions of the TeField description properties, for use in object repository descriptions, programmatic descriptions, checkpoint and output value steps, and as argument values for the GetTOProperty and GetROProperty methods.

Methods

Common Method CaptureBitmapSaves a screen capture of the object as a .png or .bmp image using the specified file name.
Common Method CheckChecks whether the actual value of an item matches the expected value.
Common Method CheckPropertyChecks whether the actual value of the specified object property matches the specified expected value within the specified timeout.
Common Method ChildObjectsReturns the collection of child objects contained within the object.
Common Method GetAllROProperties

Returns the collection of properties and current values from the object in the application.

Common Method GetROPropertyReturns the current value of the description property from the object in the application.
Common Method GetTOPropertiesReturns the collection of properties and values used to identify the object.
Common Method GetTOPropertyReturns the value of the specified description property from the test object description.
Common Method HighlightHighlights the object in the application.
Common Method OutputRetrieves the current value of an item and stores it in a specified location.
Common Method RefreshObjectInstructs UFT One to re-identify the object in the application the next time a step refers to this object.
Method SetInserts text into an unprotected field.
Method SetCursorPosPlaces the cursor in the specified position within the field.
Method SetSecureInserts text into a hidden (invisible) field.
Common Method SetTOPropertySets the value of the specified description property in the test object description.
Common Method ToStringReturns a string that represents the test object.
Common Method WaitPropertyWaits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step.

Properties

Common Property ExistChecks whether the object currently exists in the open application.
Property TextReturns the contents of a field.

Back to top

 

Set Method

Description

Inserts text into an unprotected field.

Syntax

object.Set Text, [PositionInField]

Arguments

ParameterDescription
Text Required. A String value.
The text to be inserted in the field.
PositionInField Optional. A long integer value.
The offset of the insertion position from the first character in the field (in characters). If no offset is specified, the default is 0.
Default value = 0

Return Type

None

IMPORTANT

The Set method can be used for any unprotected field. However, when recording, the Set method is used for unprotected visible fields, and the SetSecure method is used for hidden fields. For more information, see SetSecure.

Example

Back to top

 

SetCursorPos Method

Description

Places the cursor in the specified position within the field.

Syntax

object.SetCursorPos [PositionInField]

Arguments

ParameterDescription
PositionInField Optional. A long integer value.
The offset of the insertion position from the first character in the field (in characters). If no offset is specified, the default is 0.
Default value = 0

Return Type

None

Example

Back to top

 

SetSecure Method

Description

Inserts text into a hidden (invisible) field.

Syntax

object.SetSecure CodedString

Arguments

ParameterDescription
CodedString Required. A String value.
UFT One decodes and inserts the coded string into the field.

Return Type

None

IMPORTANT

  • A hidden field is typically used for a password. The SetSecure method is recorded when a password or other secure text is entered. The text is encrypted while recording, and decrypted during the test run.

  • The Set method can be used instead of the SetSecure method for any unprotected or hidden field. However, when recording, the Set method is used for unprotected fields and the SetSecure method for hidden fields. For more information, see Set.

  • To find the encoded value to use as the argument for the this method, do one of the following: 

    • Use the Password Encoder utility (available from the Windows Start menu).

    • Parameterize the argument using a Data Table parameter and use the Data Table encryption option (right-click each unencrypted value in the password column and choose Data > Encrypt).

    For more information, refer to the UFT One User Guide.

  • While the SetSecure method enables you to hide passwords on the screen during a run session, it is not intended to be a secure way to protect password information.

Example

Back to top

 

Text Property

Description

Returns the contents of a field.

Syntax

object.Text

Value Type

A String value.

Property type

Read-only property

Example

Back to top

See also: