Editbox Control

A box in which text can be typed. Whatever the user types in the EDITBOX will be assigned to the defined variable.

Normally, when a dialog box opens, the EDITBOX is empty. You can change this by assigning a value to the string variable before calling the Dialog function, in which case the value of the variable will be displayed in the EDITBOX .

Note: Variable names that begin with "PW_", will be treated as password fields causing asterisks to be echoed for the actual characters that the user types.

Limit for EDITBOX controls on Windows is the lesser of approximately 2147483646 characters or available memory.

Return Value:

The EDITBOX control will return the users selection in the variable you supply as the Variable attribute in the controls definition.

Control Definition:

<dlg-variable>nn =`x, y, width, height, type, control-name, variable, text, value, tab-order, style, font, textcolor, backgroundcolor`

For Example:

MyDialog001=`069,027,036,DEFAULT,EDITBOX,"EditBox_1",ebVariable1,"Edit 1",DEFAULT,30,DEFAULT,DEFAULT,DEFAULT,DEFAULT`

Attribute

Value

Meaning

dlg-variable

MyDialog

The name of the dialog box.

001

The ordinal position of the control in the dialog box (starting with 1).

069

The horizontal coordinate of the upper left corner of the control in Dialog Units.

027

The vertical coordinate of the upper left corner of the control in Dialog Units.

width

036

The width of the control in Dialog Units

height

DEFAULT

The height of the control in Dialog Units. [This should be DEFAULT for this control]

type

EDITBOX

The type of control.

control-name

"EditBox_1"

The name used to identify the control in a user defined callback procedure. The name cannot be more than 30 characters in length and MUST be unique. ( This attribute can only be used with 6.2 or later dialog formats. )

variable

ebVariable1

The name of the variable affected by the control.

Note: Variable names that begin with "PW_", will be treated as password fields causing asterisks to be echoed for the actual characters that the user types.

text

"Edit 1"

The description which will be displayed with the control. [Use an empty string ("") if the control should appear blank.]

value

DEFAULT

Not applicable to this control

tab-order

Allows you to specify a control's tab order independently of a control's position or name in the dialog template. Tab-order controls the order in which controls are accessed when the keyboard is used to navigate the dialog. It also influences which control is on top when controls have overlapping positions in the dialog. It can be any positive integer, but each control should have a unique number.

When you navigate through a dialog using the tab key, lower number controls will be given the keyboard focus before higher controls. Likewise, low-numbered overlapping controls will appear on top of higher numbered controls. If you specify the DEFAULT keyword for this attribute or if you give two controls the same tab order, a tab order will be arbitrarily assigned to the control.

Note: The dialog function, under certain circumstances, may change the tab order you specify. The GROUPBOX controls tab order may be adjusted so that it is smaller than any of the controls it contains. In addition, the tab order of the controls inside the GROUPBOX may be adjusted so that they are consecutive.

style

DEFAULT

Allows you to control the initial appearance and behavior of your control. Numbers represent each style and they can be combined, using the bit-wise OR (|) operator, to set multiple styles. The following table lists the style constants and their meanings.

Style	Meaning
@csInvisible (1)	Control is invisible
@csDisabled (2)	Control has disabled appearance and does not accept any user input, it would otherwise accept input.
@csReadOnly (8)	The controls text cannot be changed by typing in new text when the control has the input focus. (Note: The user can still change the value in a SPINNER controls by using the up and down arrows.)
@csPassword (16)	Displays all characters as an asterisk (*) as they are typed into the control.
@csDigits (64)	Allows only digits to be entered into the edit type controls. (Note: even with this set, it is still possible to paste non-digits into the edit control.)
@csCenter (512)	Control's text is centered in control's viewing area.
@csRight (1024)	Control's text is right aligned in control's viewing area.
@csCurLeft (2048)	Prevents text selection when control gets the input focus. Cursor is placed to the left of any existing text in the control.
@csCurRight (4096)	Prevents text selection when control gets the input focus. Cursor is placed to the right of any existing text in the control.

Note: Specifying 0 for this attribute is equivalent to using the DEFAULT keyword and means that the control will exhibit default behavior.

font

DEFAULT

The font used to display a control's text. The font description should be delimited by double quote (") marks unless the attribute is set to DEFAULT. If this attribute is set to DEFAULT, the font specified as the value of the main dialog font will be used. If the main dialog font is set to DEFAULT, the system font is used. You do not need to provide any value for this attribute unless you are also specifying text or background color. For details see the Dialog Fonts topic. WARNING: If a font is selected that doesn't exist on the user's system, a substitution will be made. We recommend using commonly available fonts.

textcolor

DEFAULT

The color of text associated with a control. Color is specified by three vertical bar (|) delimited numbers ranging from 0 to 255 or a single hexadecimal number preceded by the letter 'h'. The numbers represent one of the RGB colors: red, green or blue, in that order. The complete color specification must be surrounded by double quotes (") unless the DEFAULT key word is used. If this attribute is set to DEFAULT, the color listed in the main dialog's text color will be used. If a color is not specified for the dialog, the system text color will be used.

backgroundcolor

DEFAULT

Used to change the color displayed behind a controls text. Color is specified by three vertical bar (|) delimited numbers ranging from 0 to 255 or a single hexadecimal number preceded by the letter 'h'. The numbers represent one of the RGB colors (red, green or blue, in that order). The complete color specification must be surrounded by double quotes (") unless the DEFAULT keyword is used. If no color is specified or the DEFAULT keyword is used the system background color will be used.

Event Options

Use the DialogProcOptions function to control when your User-Defined-Callback procedure is called by its associated dialog. You can also use it to control your dialog's behavior, while your procedure is executing. You usually establish callback events during the first call to the procedure i.e., event 0, but this can be done during any call.

Event-Option-Code Values	Meaning
@deEdText (5)	Changed text in EDITBOX or MULTILINEBOX: User has changed the text in an EDITBOX or MULTILINEBOX control

Dialog Callback Procedure Function Options

DialogControlGet function returns text and state information associated with a control.

Request	Meaning
@dcText (3)	All text currently in the control.
@dcBackColor (11)	Background color specified by three vertical bar (\|) delimited numbers ranging from 0 to 255. If the control is using the system default color, the string "DEFAULT" is returned.
@dcTextColor (13)	Text color specified by three vertical bar (\|) delimited numbers ranging from 0 to 255.. If the control is using the dialog's default text color, the string "DEFAULT" is returned.
@dcPosition (17)	Space delimited list of a control's position and size in dialog units relative to the dialog's client area. The first two numbers are the horizontal and vertical location of the upper-left corner of the control while the third and fourth numbers are the width and height of the control.
@dcMenuNames (18)	Tab delimited list of menu item names associated with the control, menu item or menu bar.
@dchWnd (19)	Window handle of a dialog control.

DialogControlSet function changes the text or appearance of a control.

Request	Meaning
@dcText (3)	Text replaces the existing text
@dcBackColor (11)	Background color. The color is specified by three vertical bar (\|) delimited numbers ranging from 0 to 255. To give the control the system default background color, use an empty string ""or the "DEFAULT "key string for this parameter.
@dcTextColor (13)	Text color. The color is specified by three vertical bar (\|) delimited numbers ranging from 0 to 255. To give the control the dialog's default text color, use an empty string ""or the "DEFAULT "key string for this parameter
@dcPosition (17)	Space delimited list of a control's position and size in dialog units relative to the dialog's client area. The first two numbers are the horizontal and vertical location of the upper-left corner of the control while the third and fourth numbers are the width and height of the control.

DialogControlState function changes a control’s style or gives control input focus.

Style	Meaning
@csInvisible (1)	Control is invisible
@csDisabled (2)	Control has disabled appearance and does not accept any user input, it would otherwise accept input.
@csReadOnly (8)	The controls text cannot be changed by typing in new text when the control has the input focus. (Note: The user can still change the value in a SPINNER controls by using the up and down arrows.)
@csPassword (16)	Displays all characters as an asterisk (*) as they are typed into the control.
@csDigits (64)	Allows only digits to be entered into the edit type controls. (Note: even with this set, it is still possible to paste non-digits into the edit control.)
@csCurLeft (2048)	Prevents text selection when control gets the input focus. Cursor is placed to the left of any existing text in the control.
@csCurRight (4096)	Prevents text selection when control gets the input focus. Cursor is placed to the right of any existing text in the control.