Please enable JavaScript to view this site.

ESL Documentation

Definition

Define a key.

[enabled|disabled] [visible|invisible] [[color] COLOR]

key KEY_NAME at{[position] X Y|default position}

[in PARENT_NAME1 [in PARENT_NAME2] ... ]

[priority is PRIORITY_NO]

[parameter is PAR_STRING]

[helpid is HELP_ID]

[DRAWING_STATEMENT] ...

enabled | disabled

Define the key as selectable or not. If you define the key 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 string value, integer value, or color keyword representing an ESL color. The default is white.

KEY_NAME

The identifier for a key.

at position X Y

Integer values representing the position of the key.

at default position

When the parent is a graphical region, position the object at the graphics cursor of the parent; otherwise, position the object at 0 0.

in PARENT_NAMEn

The identifier for a parent object. The default ancestry for a key is in primary region (or in master for a fullscreen key).

priority is PRIORITY_NO

An integer value representing the priority of the key. The default priority is 0.

parameter is PAR_STRING

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

helpid is HELP_ID

Because a key cannot have the focus, you cannot use HELP_ID to display a help panel for a key. However, you can use helpid as a second parameter.

DRAWING_STATEMENT

A drawing statement.

Description

When specifying attributes, you can specify the priority and parameter in any order. You must specify the other attributes in the order shown in the model. Only the key specification, the identifier, and the at specification are required. Other attributes are optional, using the defaults shown in the model.

Example

key Start at position 100 200

move 20 20

box 30 30

disabled red key Times at default position in CalcPic

parameter is "Times"

box 22 22

move 8 6

text "*"

red key Shape at position 100 100

box 150 150

See Also

color Keyword

enabled and disabled Attribute Definitions

parameter is Attribute Definition

position Keyword

priority is Attribute Definition

visible and invisible Attribute Definitions