Category: FormFields (FFs)

A numeric code indicating the “class” (field or widget type) of the associated form field.

Valid Values

WdgType = {30 where FT = “0”, 31 where FT = “1”,

A numeric value ranging from 1 to the maximum available widgets according to the table below:

The callback events an object can raise.

Valid Values

An integer code combining the following values:

Remarks

Only resizable windows can have menus.

Example: If the object has to raise a GotFocus event and a Click event, the WdgCallbacks would contain (2 + 64) = 66.

Provides extra information about the object being used.

Valid Values

A character string, up to 512 characters long either blank or in JSON format.

Remarks

The WdgCSS values for the objects involved present either a blank value or a free-format JSON syntax containing additional information about the object. This extra information may be Data Dictionary fields valid only to the particular object or implemented for future use.

Example

{"icon": "c:/images/zx.ico", "smallincrement":30}

ZIM:X allows JSON data format to be retrieved by the means of the $FindJSON function if the above value would be stored in FFs.WdgCSS:

LIST FFs FORMAT $FindJSON(WdgCSS, "smallincrement")
30

See Also

$FindJSON

These numeric constants are in Zim’s data dictionary. They can be used instead of the number value to make your code more readable.

“Autoselect” status of a form field. Indicates whether the content of a form field is automatically “selected” when the form field acquires focus. (For text-entry form fields, WdgAutoSelect and AC (autoclear) are the same.)

Valid Values

An integer code, as shown in the table below:

Remarks

WdgAutoSelect is not respected when the focus shift into the field occurs as the result of a mouse button press. The reason is that pressing the left mouse button starts a “pending” operation (i.e., selection in entry fields, “arming” in check boxes), and the user’s intent is not clear until the button is released and the mouse position checked.

See Also

AC

Stores initial values for lists. The initial list of values for a combo box or list box are stored in WdgItems.

Valid Values

A 256-character string, containing a list of values separated by semicolons

Remarks

If the length of any item in the list exceed the field’s FieldLen, then that item is truncated.

Leading spaces are stripped from all items.

Example 1

Red;Green;Blue

Example 2

If the semicolon must be used as data, it should be preceded by the escape character ():

period (.);comma (,);semicolon (;)

See Also

FieldLen, FORM SET LIST (Language Reference)

Response of a form field to a change in value (Modified) event. Indicates how the form field responds to a change in value (Modified) event.

Valid Values

A 1-character code, as shown in the table below:

Remarks

If WdgModified is set to Y, then FORM INPUT will transmit any time the end-user changes the value of the form field (for entry fields, this occurs for every press of a key that is not simply cursor motion).

If WdgModified is trapped, then LostFocusModified events (IT = Y) will never occur.

See Also

IT

The label that is to be attached to this form field, or the text that is to appear in a window’s caption.

Valid Values

A character string (up to 256 characters for FormFields; up to 64 characters for Windows)

Remarks

For FormFields

The location of the label varies with the class and subclass of the form field, and the WdgLabelPosition.

To designate a character in the label as the mnemonic accelerator for the form field or menu item, place an ampersand immediately preceding the desired character (e.g., &Quit). The character appears underscored in the label. When the form field is used in a display, pressing the mnemonic accelerator (in combination with Alt/Extended Char/Compose) causes the object’s acceleration action to occur.

For Windows

If WdgCaption is set to 0 (no), WdgLabel is ignored.

If WdgLabel is left blank, it defaults to the null string (“”).

This attribute is Meaningful for graphic-class windows only.

See Also

FT, WdgCaption, WdgClass, WdgLabelPosition, WdgSubClass

Effect of a mouse click in a form field. Indicates whether a Click event is to be returned to the application program when a mouse click occurs in this form field.

Valid Values

A 1-character code, as shown in the table below:

Remarks

A click can occur if the form field is available or guarded. If the field is guarded, the event occurs as soon as the left mouse button is pressed. If the field is available, the left mouse button must be pressed and released without producing some other action (e.g., text selection in an entry field).

See Also

FT, PM

The data type of the form field’s value.

Valid Values

A 1-character code, as shown in the table below:

See Also

DataMask, WdgInputMask