Field WdgType

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:

CodeMeaning
1Label
2Entry Field
3ToggleButton
4PushButton
5Menu Item
6Frame
7ListBox
8ComboBox
9OptionBox
10Picture
11Graphic
12Divider
13ScrollBar
14UserMessage
17OLE Object
19TabControl
20TabPage
21GridControl
22Calendar
23Camera
24TreeView
25Signature
26BarCode
27ProgressBar
28TreeView Node
29ListView
30Video
31WebPage

Field WdgCallbacks

The callback events an object can raise.

Valid Values

An integer code combining the following values:

Code

Meaning

0

No callback events are raised.

1

When the object is modified (MODIFIED).

2

When a click is applied to the object (CLICK).

4

When a double-click is applied to the object (DOUBLECLICK).

8

When a right-click is applied to the object (RIGHTCLICK).

16

When an ActiveX object raises a callback event (ACTIVEX).

32

When a click occurs on the header of the object (HEADER).

64

When the object gets the focus (GOTFOCUS).

128

When the object loses focus (LOSTFOCUS).

256

When the object loses focus after being modified (LOSTFOCUSMODIFIED).

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.

Field WdgCSS

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

Predefined Color Constants

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

Color Constant NameValueColor Constant NameValue
Inherited from the parent0cInactiveCaptionTxt19
Black1cWindowText20
Blue2cWindowFrame21
Green3cScrollBarColor22
Cyan4cMenuTextColor23
Red5cMenuColor24
Magenta6cInactiveCaption25
Brown7cInactiveBorder26
LightGrey8cHighlightText27
DarkGrey9cHighlightColor28
LightBlue10cGreyText29
LightGreen11cCaptionText30
LightCyan12cButtonText31
LightRed13cButtonShadow32
LightMagenta14cButtonFace33
Yellow15cWindowBackground34
White16cAppWorkSpace35
cWindowColor17cActiveCaption36
cButtonHighlight18cActiveBorder37

Field WdgAutoSelect

“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:

Code

Meaning

0

No

1

Yes

 

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

Field WdgItems

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)

Field WdgModified

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:

Code

Meaning

N

(DEFAULT) No notification

Y

Control returns to the application program if the form field is modified

 

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

Field WdgLabel

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

Field WdgClick

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:

Code

Meaning

N

(DEFAULT) No

Y

Yes

 

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

Field DT

The data type of the form field’s value.

Valid Values

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

Code

Meaning

A

Alphanumeric (letters, digits, punctuation)

D

Date (digits in accordance with the mask specified for the form field (e.g., MM/DD/YY))

M

Message

N

Numeric (digits, decimal point, plus and minus signs)

T

Non-digit (any characters except digits)

 

See Also

DataMask, WdgInputMask

pt_BRPortuguese