PhraseDroplist

(System Library)

Description:

Language sensitive Droplist.

Returns: Nothing
Usage: Steady State only.
Function Groups: Graphics
Related to: PhraseEdit
Format: System.PhraseDroplist(X1, Y1, X2, Y2, PhraseIDArr, Title, Index, ID, Trigger, NoEdit, PhraseId[, DrawBevel, VertAlign, AlignTitle, Style, BGColor, FGColor, FontParm, TitleBGColor, TitleFGColor, BevelColor, SortPhrases])
Parameters:  
X1
Required. Any numeric expression giving the X coordinate on the screen of one side of the graphic.
Y1
Required. Any numeric expression giving the Y coordinate on the screen of either the top or bottom of thegraphic.
X2
Required. Any numeric expression giving the X coordinate on the screen of the side of the graphic opposite to X1.
Y2
Required. Any numeric expression giving the Y coordinate on the screen of the top or bottom of the graphic, whichever is the opposite of Y1.
PhraseIDArr
Required. An array containing Phrase IDs (keys) for the list.
Title
Optional text expression to be used as a title for the droplist. Set to Invalid for no title.
Index
Required Numeric. The index variable to update within the array.
FocusID
Boolean. If this value is FALSE (0), the field will display its current setting, but cannot be opened (i.e. its value cannot be changed), and will appear disabled (grayed-out).
Trigger
Optional numeric. Trigger provides feedback. While editing, the value will be 0. When editing is complete (tab, enter or loss of focus) the value will change to non-zero: 1 if enter is pressed, 2 otherwise.
NoEdit
Optional Boolean. Set TRUE to prevent direct editing of the text.
PhraseID
Required text. ID (phrase key) of the current value entered in the dialog.
DrawBevel
Optional Boolean expression that when set to TRUE, causes a bevel to be drawn around the control. Defaults to TRUE. If the editfield is beveled, its size will become fixed and will be the same as that for a droplist.
VertAlign
An optional parameter that is any numeric expression that sets the vertical alignment of the editfield according to one of the following options:

VertAlign

Vertical Alignment

0

Top

1

Center

2

Bottom

Whether the title is included when the vertical alignment is calculated is determined by the value of AlignTitle. The default value is 0.

AlignTitle
Optional Boolean. If AlignTitle is TRUE (non-0), the title will be included in the calculation for vertical alignment. If AlignTitle is FALSE (0), the title will be added to the editfield after both the editfield and its bevel have been vertically aligned. The default is true.
Style
Optional. Comprised of a combination of bit values to yield the desired effects.
Bits 0 and 1 define mutually exclusive styles of operation. They can be set to one of the following values:

Bit Number

Definition

0

No droplist, rather a listbox with the selected item above

1

Droplist and editable selection

2

Droplist with non-editable selection


Bits 2 and 3 define input character handling. If neither is set, input is passed to script code as typed.

Bit Number

Definition

2

Input is converted to all uppercase.

3

Input is converted to all lowercase.

Bit 4 controls list sorting.

Bit Number

Definition

4

The list is presented in sorted order to the user.

Bit 8 enables Windows visual styles.

Bit 9 defines and enables exact use of application-defined geometry. The default is to perform auto-geometry modification to give the best fit.

Bit Number

Definition

9

Enable application-defined geometry.

BGColor
Optional. Background color of the dropList
FGColor
Optional. Foreground (text) color of the dropList
FontParm
Optional Font value.
TitleBGColor
Optional. Background color under title

TitleFGColor

Optional. Foreground (text) color of the title.
BevelColor
Optional. Color of the bevel line.
SortPhrases
Optional Boolean. If present and TRUE, the entries in the list will be sorted by the translated phrase.
Comments:

Droplist used to select a PhraseID by presenting the user with a droplist full of translated phrases. If CanEdit is TRUE then it is possible for the user to input new labels, in which case they will be added to the list and will be added to the language manifest.

Examples: