Attributes

name

Optional string. The text that is to be displayed in the popup window, such as 'Enter your response here:'.

description

Optional string. A description of this action. This description is not displayed.

row

Required integer. The row on the host terminal at which you want the macro runtime to start typing the input from the user.

col

Required integer. The column on the host terminal at which you want the macro runtime to start typing the input from the user.

len

Required integer. The number of characters that the user is allowed to enter into the prompt input field.

default

Optional string. The text to be displayed in the input field of the popup window. If the user does not type any input into the input field but just clicks OK, the macro runtime will send this default input to the host terminal.

clearfield

Optional boolean. Setting this attribute to true causes the macro runtime, before sending the input sequence to the host terminal, to clear the input field of the host terminal in which the row and column location occur.

encrypted

Optional boolean. Setting this attribute to true causes the macro runtime, when the user types a key into the input field of the window, to display an asterisk (*) instead of the character associated with the key.

movecursor

Optional boolean. Setting this attribute to true causes the macro runtime to move the cursor to the end of the input.

xlatehostkeys

Optional boolean. Setting this attribute to true causes the macro runtime to interpret the names of action keys (such as [enter]) as action keys rather than as sequences of characters.

assigntovar

Optional variable name. Setting this attribute to a variable name causes the macro runtime to store the input into the variable whose name you specify here.

varupdateonly

Optional boolean. Setting this attribute to true causes the macro runtime to store the input into a variable and not to send it to the host terminal. This attribute takes effect only if the assigntovar attribute is set to true.

required

Optional boolean. Setting this attribute to true causes the macro runtime to disable the OK button in the prompt window until the input field of the prompt window contains text. The input field can contain text either because you have specified a Default Response or because the user has typed text into the input field.

screenorientation

Optional string. Use this attribute to define the host screen orientation to use for the prompt during macro playback at runtime. Options are LTR and RTL.