Description: Windows native edit control. This function returns a value indicating the status of an edit field.
Returns: Numeric
Usage: Steady State
Format: WinEditCtrl(X0, Y0, X1, Y1, Style, Data [, 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 are reserved for bit compatibility with WinComboCtrl, and should be set to "0".
Bits 2^2 and 2^4 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
16 Input is masked. Any characters typed will appear as asterisks. This is useful for such things as password fields.
Bit 2^5 controls multi-line edit controls.
32 Multiline editing. Setting this bit causes a typed <CR> (Enter or Return) to be interpreted as "move to the start of the next line". Text that contains <CR> characters has a line break inserted at each <CR>.
Bits 2^6 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 { varies } { required } { no default: }
The data to be displayed and/or edited.
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 { numeric } { optional } { no default: }
An optional parameter indicating the font to use.
Comments: The return value for WinEditCtrl can be one of the following:
|
Return Value |
Meaning |
|
Invalid |
Nothing happened or there is a problem with the control |
|
0 |
Internal buffer changed or selection made from list. |
|
1 |
<CR> (Enter or Return pressed). Only applies to single-line edit controls. |
|
2 |
Focus has been lost. |
If FocusID is Invalid or less than or equal to "0", the current selection cannot be modified.
See Also:
DropList | Edit | WinComboCtrl | ZEditField