Difference between revisions of "DIALOG GET"

From Recital Documentation Wiki
Jump to: navigation, search
Line 20: Line 20:
  
 
==See Also==
 
==See Also==
[[@...GET]], [[DIALOG FIELDS]], [[DIALOG MESSAGE]], [[DIALOG QUERY]],  [[DIALOG SCOPE]], [[Function Keys]], [[SET COLOR]], [[SET COLOR OF]], [[SET DIALOG]]
+
[[@...GET]], [[DIALOG FIELDS]], [[DIALOG MESSAGE]], [[DIALOG QUERY]],  [[DIALOG SCOPE]], [[Function Keys]], [[SET COLOR]], [[SET COLOR OF]], [[SET DIALOG]], [[SET SHADOW]]
  
  

Revision as of 13:45, 19 June 2009

Class

Screen Dialogs


Purpose

Display a dialog prompting for user input


Syntax

DIALOG GET <character memvar>

[HELP <expC1>]

[LABEL <expC2>]

[PICTURE <expC3>]

[TITLE <expC4>]


See Also

@...GET, DIALOG FIELDS, DIALOG MESSAGE, DIALOG QUERY, DIALOG SCOPE, Function Keys, SET COLOR, SET COLOR OF, SET DIALOG, SET SHADOW


Description

The DIALOG GET command prompts for user input using a dialog box. The box contains confirmation buttons labeled "OK" and "CANCEL". The screen is automatically saved and restored when the DIALOG GET command is used. The SET COLOR and SET COLOR OF DIALOGFRAME commands may be used to specify the colors for the dialog box and frame.

If the <character memvar> does not exist, DIALOG GET will initialize it as a character string. If the memory variable does exist and is of character data type, its value will be retained. If it does exist, but is of any other data type, it will be changed to an empty character string with a length of 80 characters. The user enters the required value in the editing region then presses the [RETURN] key. Confirmation buttons, "OK" and "Cancel" are then highlighted. The [EXIT/SAVE] and [ABANDON] keys can also be used to save and exit or cancel and exit. The [CURSOR UP] key can be used to return to the editing region.

On exit from the DIALOG GET, the <character memvar> will contain the new value. If the [ABANDON] key or the "Cancel" button was pressed, <character memvar> will return an empty string.

HELP <expC1>

The HELP clause will display the text message <expC1> in the system message line.

LABEL <exp2C>

The LABEL clause specifies the input prompt <expC2> for the dialog. The character expression can be up to 15 characters long and replaces the default prompt, "Enter Value".

PICTURE <expC>

The optional PICTURE clause is used to create a picture-editing template, see @...GET for more details.

TITLE <expC>

The TITLE clause will replace the default title, "INPUT DATA" in the GET dialog with <expC4>. The <expC4> should be no longer than 30 characters, or it will display outside the boundaries of the box.


Example

dialog get m_var


Products

Recital Mirage Server, Recital Terminal Developer