Text Box Syntax

Syntax

Text_Entered = [ [ %Directives% ][[[ Max_Chars ]. ] Width ] Variable_Name [ ! Event ][ ? Enabled ] ]

Note : You must not have any space characters in the finished command.

Argument

Type

Description

%Directives%   Refer to Xdialog Language Directives and Operators.
Text_Entered

C

The user's input into the Text Box. By default there is no limit to the size of the string that may be returned.   Width, if present, limits the size of type-in text field and the string that is returned. .Width, if present, limits only the size of type-in text field. Max_Chars, if present, overrides Width to set the limit to the size of the string that is returned.
[]

C

The leading [ and trailing ] characters are required.
Max_Chars

N

An integer value for the maximum number of characters to be accepted as input.
Variable_Name

C

The name of the variable that is being set by the control.
Width

N

The width of the control.
Event

C

Optional. See Event Syntax.
Enabled

L

Optional. See Enabled Syntax.

Description

One or more Text Boxes may appear inside the Format section of a UI_DLG_BOX() function. Note that all text box entries are left aligned.

To control the left padding of the data in text box controls, see A5.SYSTEM_MODE_SET().

Example

This script creates a dialog with a default field size: [Picture]

result=ui_dlg_box("Title",<<%dlg%

Filename: [filename];

<OK>

%dlg% )

The next script creates a Text Box with a 20 character wide field. The user can enter only 20 characters. [Picture]

result=ui_dlg_box("Title",<<%dlg%

Filename: [20filename];

<OK>

%dlg% )

The following script sets the size of the Text Box to 20 characters, but allows the user to enter up to 128 characters for the filename: [Picture]

result=ui_dlg_box("Title",<<%dlg%

Filename: [128.20filename];

<OK>

%dlg% )

See Also

Xdialog Language Directives and Operators, Xdialog Control Reference

Supported By

Alpha Five Version 5 and Above