TeScreen Object

Description

A terminal emulator screen that fully supports HLLAPI.

IMPORTANT

The TeScreen object represents the application area. It changes each time input is received from the host.

By default, UFT One identifies a screen object using its label property. The value of the label property 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 description properties are part of the TeScreen test object description and are therefore not available in the Object Identification dialog box. For more information on the Object Identification dialog box, see the UFT One User Guide.

Operations

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

Note: You can also view a list and descriptions of the TeScreen 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.

Method GetCursorPosReturns the position of the cursor in the emulator screen.
Common Method GetROPropertyReturns the current value of the description property from the object in the application.
Method GetTextReturns the text from the specified screen rectangle.
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 SendKeySends a keystroke or string of keystrokes to the current cursor position in the emulator screen.
Method SetCursorPosChanges the position of the cursor within the emulator screen.
Method SetTextCopies a string to a specific location in the emulator screen.
Common Method SetTOPropertySets the value of the specified description property in the test object description.
Method SyncWaits until a response is received from the host and the emulator status is set to Ready, or until the timeout is reached, before continuing with the run session.
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.
Method WaitStringWaits for a specified string to appear on the emulator screen before continuing the run session.

Properties

Property ColumnCountReturns the total number of columns in the emulator screen.
Common Property ExistChecks whether the object currently exists in the open application.
Property RowCountReturns the total number of rows (lines) on the emulator screen.

Back to top

 

GetCursorPos Method

Description

Returns the position of the cursor in the emulator screen.

Syntax

object.GetCursorPos ScreenRow, ScreenCol

Arguments

ParameterDescription
ScreenRow Required. A Variant.
The retrieved row position of the cursor in the emulator screen. The first row in the screen is 1.
ScreenCol Required. A Variant.
The retrieved column position of the cursor in the emulator screen. The first column in the screen is 1.

Return Type

None

IMPORTANT

Typically, you use this function to ensure the cursor is at the correct location in the screen before sending data using the SendKey method. For more information, see SendKey.

Example

                    'The following example uses the GetCursorPos method to verify that the cursor is
'located at row 14, column 36. If the position is correct, the ENTER key is sent
'to the emulator screen. Otherwise an error message is inserted in the test
'results.
TeWindow("TeWindow").TEScreen("Sign On").GetCursorPos row, Col
If row = 14 And Col = 36 Then
    TeWindow("TeWindow").TEScreen("Sign On").SendKey TE_ENTER
Else
    Reporter.ReportEvent 1, "Wrong Cursor Position", "Row = " & row & ",Col = " & Col
End If

Back to top

 

GetText Method

Description

Returns the text from the specified screen rectangle.

Syntax

object.GetText ([TopRow], [LeftCol], [BottomRow], [RightCol])

Arguments

ParameterDescription
TopRow Optional. A long integer value.
The top coordinate of the rectangle. The first row in the screen is 1.
Default = 1

Default value = 0
LeftCol Optional. A long integer value.
The left coordinate of the rectangle. The first column in the screen is 1.
Default = 1

Default value = 0
BottomRow Optional. A long integer value.
The bottom coordinate of the rectangle.
Default = last row number

Default value = 0
RightCol Optional. A long integer value.
The right coordinate of the rectangle.
Default = last column number

Default value = 0

Return Type

A String value.

IMPORTANT

The rectangle is defined by pairs of coordinates that designate two diagonally opposite corners of the rectangle. To get the total number of rows and columns on the screen, use the RowCount and ColumnCount methods.

Example

                    'The following example uses the GetText method to retrieve all the text from the
'"Flights LOGON" screen.
FullText = TeWindow("TeWindow").TEScreen("Flights LOGON").GetText()
                    'The following example uses the GetText method to retrieve the text from the
'specified screen rectangle created from the coordinates at row 4, column 7 and
'row 19, column 75.
ScrText = TeWindow("TeWindow").TEScreen("Flights LOGON").GetText(4, 7, 19, 75)

Back to top

 

SendKey Method

Description

Sends a keystroke or string of keystrokes to the current cursor position in the emulator screen.

Syntax

object.SendKey Key

Arguments

ParameterDescription
Key Required. A String value.
UFT One sends the string of keystrokes to the host presentation space. The string can contain up to 255 characters. More than one character may be required to represent a keystroke. Some key strokes can also be represented using predefined keyboard mnemonics listed in the table below.

Note: Not all terminal emulators support all keyboard mnemonics. For more information, see your emulator documentation.

Key
Mnemonic
Script Constant
@
@@
-
PA1
@x
TE_PA1
PA2
@y
TE_PA2
PA3
@z
TE_PA3
PA4
@+
TE_PA4
PA5
@%
TE_PA5
PA6
@&
TE_PA6
PA7
@'
TE_PA7
PA8
@(
TE_PA8
PA9
@)
TE_PA9
PA10
@*
TE_PA10
PF1
@1
TE_PF1
PF2
@2
TE_PF2
PF3
@3
TE_PF3
PF4
@4
TE_PF4
PF5
@5
TE_PF5
PF6
@6
TE_PF6
PF7
@7
TE_PF7
PF8
@8
TE_PF8
PF9
@9
TE_PF9
PF10
@a
TE_PF10
PF11
@b
TE_PF11
PF12
@c
TE_PF12
PF13
@d
TE_PF13
PF14
@e
TE_PF14
PF15
@f
TE_PF15
PF16
@g
TE_PF16
PF17
@h
TE_PF17
PF18
@i
TE_PF18
PF19
@j
TE_PF19
PF20
@k
TE_PF20
PF21
@l
TE_PF21
PF22
@m
TE_PF22
PF23
@n
TE_PF23
PF24
@o
TE_PF24
Alternate Cursor
@$
TE_ALTERNATE_CURSOR
Attention
@A@Q
TE_ATTENTION
Backspace
@<
TE_BACKSPACE
Backtab
@B
TE_BACKTAB
Clear
@C
TE_CLEAR
Cursor Down
@V
TE_DOWN
Cursor Left
@L
TE_LEFT
Cursor Right
@Z
TE_RIGHT
Cursor Select
@A@J
TE_CURSOR_SELECT
Cursor Up
@U
TE_UP
Delete Character
@D
TE_DELETE
Dup
@S@x
TE_DUP
Enter
@E
TE_ENTER
Erase EOF
@F
TE_ERASE_EOF
Erase Input
@A@F
TE_ERASE_INPUT
Field Exit
@A@E
TE_FIELD_EXIT
Field Mark
@S@y
TE_FIELD_MARK
Field Minus
@A@-
TE_FIELD_MINUS
Field Plus
@A@+
TE_FIELD_PLUS
Home
@0
TE_HOME
End
@q
TE_END
Insert Character
@I
TE_INSERT
New Line
@N
TE_NEW_LINE
Print Screen
@P
TE_LOCAL_PRINT
Page Down
@v
TE_PAGE_DOWN
Page Up
@u
TE_PAGE_UP
Reset
@R
TE_RESET
System Request
@A@H
TE_SYS_REQ
Tab
@T
TE_TAB
Help
@H
TE_HELP
¢ (cent)
@A@c
TE_TEST
| (solid vertical bar)
@A@v
-
Backward Word
@A@z
-
Card Reader
@W
-
Cursor Left Double
@A@L
-
Cursor Right Double
@A@Z
-
Device Cancel
@A@R
-
Magnetic Slot Reader
@Y
-
Forward Word
@A@y
-

Return Type

None

IMPORTANT

You can send data keys (for example, A, B, C) or attention identifier keys (for example, TE_ENTER or TE_PA1).

Example

                    'The following example uses the SendKey method to send the ENTER key to the
'emulator screen.
TeWindow("TeWindow").TEScreen("Flights LOGON").SendKey TE_ENTER
'or
TeWindow("TeWindow").TEScreen("Flights LOGON").SendKey "@E"

Back to top

 

SetCursorPos Method

Description

Changes the position of the cursor within the emulator screen.

Syntax

object.SetCursorPos ScreenRow, ScreenCol

Arguments

ParameterDescription
ScreenRow Required. A long integer value.
The row position is where the cursor is placed in the emulator screen. The first row in the screen is 1. To get the total number of rows in the screen, use the RowCount method.
ScreenCol Required. A long integer value.
The column position is where the cursor is placed in the emulator screen. The first column in the screen is 1. To get the total number of columns in the screen, use the ColumnCount method.

Return Type

None

IMPORTANT

Typically you use this method to place the cursor in the appropriate position before sending data using the SendKey method.

Example

                    'The following example uses the SetCursorPos method to place the cursor in the
'last row and last column of the "Flights LOGON" screen. After the cursor is in
'position, the SendKey method is used to press the ENTER key.
LastRow = TeWindow("TeWindow").TEScreen("Flights LOGON").RowCount
LastCol = TeWindow("TeWindow").TEScreen("Flights LOGON").ColumnCount
TeWindow("TeWindow").TEScreen("Flights LOGON").SetCursorPos LastRow, LastCol
TeWindow("TeWindow").TEScreen("Flights LOGON").SendKey TE_ENTER

Back to top

 

SetText Method

Description

Copies a string to a specific location in the emulator screen.

Syntax

object.SetText ScreenRow, ScreenCol, Text

Arguments

ParameterDescription
ScreenRow Required. A long integer value.
This is the row position in the screen where you want to place the string. The first row in the screen is 1. To get the total number of rows in the screen, use the RowCount method.
ScreenCol Required. A long integer value.
This is the column position in the screen where you want to place the string. The first column in the screen is 1. To get the total number of columns in the screen, use the ColumnCount method.
Text Required. A String value.
This is the string that is copied to the screen.

Return Type

None

IMPORTANT

  • If the data string being copied extends beyond the end of the field to which it is being copied in a field-formatted presentation space, data will be truncated.
  • The string size cannot exceed the screen size.
  • The SetText method can be used to enter only printable characters, not keystrokes such as TE_ENTER. After using this method to copy printable characters to the emulator screen, you can use the SendKey method to send TE_ENTER or another special key to the host.
  • This method does not change the location of the cursor.
  • You can use the GetCursorPos method to determine the position of the cursor in the emulator screen. You can then use that value as the position for the SetText method.

Example

                    'The following example uses the SetText method to copy the "Bravo" string to
'the current cursor position in the screen.
TeWindow("TeWindow").TEScreen("Flights LOGON").GetCursorPos row, Col
TeWindow("TeWindow").TEScreen("Flights LOGON").SetText row, Col, "Bravo"

Back to top

 

Sync Method

Description

Waits until a response is received from the host and the emulator status is set to Ready, or until the timeout is reached, before continuing with the run session.

Syntax

object.Sync [lMilliseconds]

Arguments

ParameterDescription
lMilliseconds Optional. A long integer value.
The time, in milliseconds, after which UFT One continues to the next step if the specified value is not achieved. If no value is specified, UFT One uses the time set in the Object Synchronization Timeout option in the Run pane of the Test Settings dialog box.
 
For more information, refer to the Terminal Emulator Add-in in the Add-ins section of the UFT One Help Center.

Default value = 0

Return Type

None

IMPORTANT

A Ready emulator status indicates that the emulator is able to receive user input.

This method uses the Object Synchronization Timeout set in the Run pane of the Test Settings dialog box if no timeout is specified. UFT One automatically inserts a Sync statement each time the emulator waits for a response from the host.

Note: Neither the Active Screen nor the Run Results Viewer displays a screen capture for the Sync step.

Example

                    'The following example uses the Sync method to wait for the "Flights LOGON"
'screen to synchronize before continuing to the next step.
TeWindow("TeWindow").TEScreen("Flights LOGON").SendKey TE_ENTER
TeWindow("TeWindow").TEScreen("Flights LOGON").Sync

Back to top

 

WaitString Method

Description

Waits for a specified string to appear on the emulator screen before continuing the run session.

Syntax

object.WaitString (Text, [TopRow], [LeftCol], [BottomRow], [RightCol], [Milliseconds], [RegExp])

Arguments

ParameterDescription
Text Required. A String value.
The text string that must appear on the screen. If the value of the RegExp argument is True, UFT One recognizes the string as a regular expression.
TopRow Optional. A long integer value.
The top coordinate of the rectangle. The first row in the screen is 1.
Default = 1

Default value = 0
LeftCol Optional. A long integer value.
The left coordinate of the rectangle. The first column in the screen is 1.
Default = 1

Default value = 0
BottomRow Optional. A long integer value.
The bottom coordinate of the rectangle.
Default = last row number

Default value = 0
RightCol Optional. A long integer value.
The right coordinate of the rectangle.
Default = last column number

Default value = 0
Milliseconds Optional. A long integer value.
The time, in milliseconds, after which UFT One continues to the next step if the specified value is not achieved. If no value is specified, UFT One uses the time set in the Object Synchronization Timeout option in the Run pane of the Test Settings dialog box.
Default value = 0
RegExp Optional. A long integer value.
If True, UFT One recognizes the String argument as a regular expression. If False, UFT One recognizes this argument as text. For more information about regular expressions, refer to the UFT One User Guide.
Default = False

Default value = 0

Return Type

A Boolean value.

This method returns a value of True if the specified string appears on the screen, or False if the timeout period expires before the string appears.

IMPORTANT

You can optionally define a specified rectangle where the string should appear on the screen. The specified string can be a constant string or a regular expression.

Example

                    'The following example uses the WaitString method to wait for the word "User" to
'appear in a specific rectangle on the "Flights LOGON" screen or for 10 seconds to
'pass before continuing to the next screen.
TeWindow("TeWindow").TEScreen("Flights LOGON").WaitString "User", 5, 1, 5, 4, 10000
                    'The following example uses the WaitString method to wait 10 seconds for a
'string defined as a regular expression to appear on the third line of the
'screen after sending the ENTER key to the emulator. If a string appears that
'matches the regular expression, for example, "CH70001 LAST ACCESS AT 14:27:07
'ON THURSDAY", the test continues. Otherwise an error message is inserted in the
'run results.
TeWindow("TeWindow").TEScreen("Login").SendKey TE_ENTER
Res = TeWindow("TeWindow").TEScreen("Login").WaitString(".*LAST ACCESS AT \d\d:\d\d:\d\d ON .*DAY.*", 3, 1, 3, 80, 10000, True)
If Res = False Then
  Reporter.ReportEvent micFail, "Login screen", "Expected string not found"
End If

Back to top

 

ColumnCount Property

Description

Returns the total number of columns in the emulator screen.

Syntax

object.ColumnCount

Value Type

A long integer value.

Property type

Read-only property

Example

                    'The following example uses the ColumnCount method to calculate the total number
'of columns and then places the cursor in the last row and last column of the
'emulator screen.
LastRow = TeWindow("TeWindow").TEScreen("Flights LOGON").RowCount
LastCol = TeWindow("TeWindow").TEScreen("Flights LOGON").ColumnCount
TeWindow("TeWindow").TEScreen("Flights LOGON").SetCursorPos LastRow, LastCol

Back to top

 

RowCount Property

Description

Returns the total number of rows (lines) on the emulator screen.

Syntax

object.RowCount

Value Type

A long integer value.

Property type

Read-only property

Example

                    'The following example uses the RowCount method to calculate the total number
'of rows and then places the cursor in the last row and last column of the
'emulator screen.
LastRow = TeWindow("TeWindow").TEScreen("Flights LOGON").RowCount
LastCol = TeWindow("TeWindow").TEScreen("Flights LOGON").ColumnCount
TeWindow("TeWindow").TEScreen("Flights LOGON").SetCursorPos LastRow, LastCol

Back to top

See also: