Please enable JavaScript to view this site.

ESL Documentation

Definition

Define a combination box.

[enabled|disabled] [visible|invisible]

[[color] COLOR] [dropdown]

combination box CB_NAME

size WIDTH HEIGHT at [position] X Y in DB_NAME

[parameter is PAR_STRING]

[helpid is HELP_ID]

[group is GROUP_NAME]

[text size TEXT_LIMIT columns]

[text EF_STRING]

[font FONT_NAME]

[sort{ascending|descending}]

[[insert{LB_STRING | file ASCII_FILE_NAME}] ... ]

enabled | disabled

Define the combination box as selectable or not. If you define it as disabled, it is displayed grayed and cannot be selected. The default is enabled.

visible | invisible

A visible object is displayed when it is defined. An invisible object is not displayed until you specifically make it visible. The default is visible.

color COLOR

A color keyword, a string value representing a color keyword, or an integer value representing a color number corresponding to a color available on your system.

dropdown

Specifies that this will be a drop-down combination box.

CB_NAME

The identifier for the combination box.

size WIDTH HEIGHT

Integer values representing the dimensions of the combination box in dialog units.

at position X Y

Integer values representing the position of the combination box in dialog units.

in DB_NAME

The identifier for the dialog box or dialog region parent object.

parameter is PAR_STRING

A string value representing the parameter of the combination box. The default value is "".

helpid is HELP_ID

A string or integer value representing the help panel you want displayed when the user requests help for this control. This should match the help panel defined in the library specified by the help library declaration. The default value is: ""

group is GROUP_NAME

A string value identifying the group to which the combination box belongs.

text size TEXT_LIMIT columns

An integer value representing the maximum number of characters that can be entered into the entry field portion of the combination box. The default value is 32.

text EF_STRING

A string value representing the initial value that the entry field portion of the combination box will contain. The default value is "".

font FONT_NAME

The name of the font in which you want the TEXT_STRING to appear. You may use either system or ESL fonts. (See the description of the font is Font Reference Definition.)

You cannot change the font of a control at runtime.

sort ascending | descending

Sort the entries in the list box portion of the combination box in ascending or descending order. If you do not specify a sorting order, entries inserted into the list box will be added at the end.

insert LB_STRING

A string value you want inserted into the list box portion of the combination box.

insert file ASCII_FILE_NAME

A string value representing the name, including the extension, of an ASCII file you want inserted into the list box portion of the combination box.

Description

A combination box is a dialog control and must have a dialog box or dialog region as its parent.

Since a combination box contains both list box and entry field functionality, most of the operations and built-in functions available for these two control objects are also available for a combination box. The exceptions are: validation and use of the remove action statement (which combination boxes do not support); and responses (which are generated only when a line from the list box portion of the combination box is selected).

In ESL for Windows, the initial value of the entry field must exactly match one of the entries in the list box or else the entry field is empty.

Example

dropdown combination box ColorChoice_CMB

size 80 50 at 50 40 in DBName_DB

insert "Blue\nGreen\nRed"

See Also

dropdown list Definition