WinComboCtrl

Description: Windows native "combo" control. A "combo" control is an enhanced form of droplist. Displays a child window containing a Windows combo control.

Note: Programmers are encouraged to use System\DropList instead.

Returns: Nothing

Usage: Steady State

Format: WinComboCtrl(X0, Y0, X1, Y1, Style, Data, DataTrigger, Index [, FocusID, MaxCharacters, Font])

Parameters: X0, Y0, X1, Y1 { numeric } { required } { no default: }

Coordinates.

Style { numeric } { required } { no default: }

Comprised of the arithmetic sum of the following fields, to yield the desired effects.

Bits 2^0 and 2^1 define mutually exclusive styles of operation. They can be set to one of the following values:

0 Listbox with selected item above it

1 Droplist. The current droplist selection is editable.

2 Droplist. The current droplist selection is not editable.

3 Reserved.

Bits 2^2 and 2^3 define input character handling. They can be set to one of the following values:

0 Input is passed to script code as typed.

4 Input is converted to all uppercase.

8 Input is converted to all lowercase.

Bit 2^4 controls list sorting

16 List is presented to the user in alphanumerically sorted order.

Bits 2^5 and 2^8 are reserved.

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

512 Enable application-defined geometry.

Data { array } { required } { no default: }

The one-dimensional array of data to be displayed.

DataTrigger { Boolean } { required } { no default: }

Can be set to non-zero to cause control data to refresh. WinComboCtrl will set this parameter back to zero after the data has been refreshed.

Index { numeric } { required } { no default: }

The current selection index in the data array.

FocusID { numeric } { optional } { no default: }

An optional parameter indicating the focus id. If Invalid or "0", no user interaction is permitted.

MaxCharacters { numeric } { optional } { no default: }

An optional parameter indicating the maximum number of characters permitted for input.

Font { Font } { required } { no default: }

An optional parameter indicating the font to use.

Comments: The return value for WinComboCtrl can be one of the following values:

Invalid Nothing happened or there is a problem with the control.

0 Internal buffer changed

1 Selection made from list or Enter key pressed

2 Focus has been lost.

Data must be a one-dimensional array of text values. Index is a variable that receives the current selection array index, or the text value if the droplist has an editable selection and new text is entered that does not match any item in the array. If FocusID is Invalid or less than or equal to "0", the current selection cannot be modified.