The operating system name of a file or an input/output device. The file or device that the document represents.
Valid Values
Up to 256 alphanumeric and special characters (see “Remarks”, below, for details)
Remarks
Files
FileName can refer to a file that already exists, or it may contain the name of a file that the application will create.
A number of special prefix characters are available to denote particular operating system directory locations for files, as described below:
Prefix | Meaning |
) | The file is located in the work directory (a “per user” file) |
# | The file is located in the directory named in the ZIM= entry in the [ZIM] section of the ZIM.INI file (found in the Windows directory). This directory is normally the directory in which you installed Zim |
“ | The file is located in the database directory. The database directory is the default location for most Zim files; this special prefix is typically used with foreign directories |
^ | The file is located in the directory named in the IMAGEPATH= entry in the [ZIM] section of the ZIM.INI file (found in the WIndows directory). The image directory can be specified in the Screen Painter as the location for any supported image file type (e.g., bitmaps, icons, metafiles) |
~ | The file is located in the directory named in the CLIPPATH= entry in the [ZIM] section of the ZIM.INI file (found in the WIndows directory). The clip directory is used by the Screen Painter to store files involved in Cut, Copy, and Paste operations |
See Distributing Database Files for more information on how to distribute files in a Zim database.
Devices
FileName can refer to an input/output device connected to your computer.
A number of special keywords are available to refer to standard devices known to the operating system. These keywords can be used in place of specific device names in the FileName field. The keywords and the device each represents are described below:
File Name | Meaning |
$console | The terminal from which the application is being run |
$stdin$ | Standard input device as defined by the operating system |
$stdout$ | Standard output device as defined by the operating system |
$stderr$ | Output is directed to the ZimTrace window if the ZIMTRACE utility program is running. The window accumulates, displays, or logs the output to a file. If ZIMTRACE is not running, the output is discarded |
$clipboard | Standard clipboard as defined by MS-Windows |
See Also
Foreign
Indicates whether the field is a virtual field.
Valid Values
As shown in the table below:
Code | Meaning |
No | (DEFAULT) The field is a normal field |
Yes | The field is a virtual field |
Remarks
A virtual field’s value is not stored in the database, but is computed dynamically, based on the expression entered into the field’s Default attribute.
A virtual field cannot be of type varchar or varalpha
See Also
Default
“Non-null required” status of a field. Indicates whether a value other than $Null is always required for the field in an ADD or CHANGE command.
Valid Values
As shown in the table below:
Code | Meaning |
No | (DEFAULT) The field need not be assigned a non-null value |
Yes | The field must always be assigned a non-null value, either explicitly or by the field’s default attribute (see Default) |
Remarks
During an ADD command, if no value is required and none is assigned, the field’s value is set to its specified default value, which may be $Null.
Reqd is not used for fields that belong to documents.
See Also
Default
Index selectivity factors. Index selectivity factors used by Zim’s strategy optimizer.
Valid Values
A number from 0 to 1.000 (DEFAULT = 1.000)
Remarks
The index selectivity factors are relevant for indexed fields only.
Each number represents the fraction of records that you would typically expect to retrieve using an indexed lookup with a particular operator or operators.
BWSel | selectivity factor for BETWEEN |
EQSel | selectivity factor for the equals (=) operator |
LGSel | selectivity factor for all other operators (i.e., less than (<), greater than (>), less than or equals (<=), greater than or equals (>=)) |
Values closer to 0 imply a very selective index, while values closer to 1 imply an index with poor selectivity. A value of 1.000 instructs Zim to use its internal selectivity factors.
The output mask used to present the formatted data value of a field in a list, report or output command.
Valid Values
The applicable masking pattern characters depend on the data type (Type) of the field (e.g., char, varchar, alpha, varalpha, numeric, int, longint, vastint, or date).
For a more detailed explanation of mask patterns and their relation to data types, see Masking.
Remarks
The FieldMask is used automatically unless an explicit mask has been applied:
- with the $mask function; or
- with the MASK format option in Zim Reports.
If FieldMask is $Null, the field will be output without masking unless only an explicitly programmed mask will be used, if provided.
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)
“Autoskip” status of a form field. Indicates whether activating or filling the form field triggers a focus shift.
Valid Values
A 1-character code, as shown in the table below:
Code | Meaning |
N | No. The user must explicitly move focus away from this form field |
Y | Yes. The focus automatically skips to “next” form field when this form field is completely full |
Indicates the foreground color to be used for the object.
Valid Values
A non-negative integer from the color table
Remarks
If the attributes WdgFCBlue, WdgFCGreen, and WdgFCRed are all non-null, they, not FC, will determine the foreground color.
The special color code 0 indicates that the object is to take its foreground color from its parent object. For example, a check box in a frame would take the frame’s foreground color. If the FC setting for the frame is also 0, then the frame takes the window’s foreground color. If the window has no parent, and if its FC setting is also 0, then the window takes its foreground color from the Window Text Color in the MS-Windows control panel.
See Also
Predefined color constants, BC
“Autodrop” status of a drop-down list or combo box. Indicates whether the list portion of a drop-down list or combo box is to drop automatically when the form field acquires focus.
Valid Values
An integer code, as shown in the table below:
Code | Meaning |
0 | No (the end-user must trigger the drop) |
1 | Yes (the list drops automatically when the field acquires focus) |
Background color (custom). “Blends” a custom background color for the object, indicating the quantity of blue, green, and red to be used in the custom color.
Required: When BC is set to $Null.
Valid Values
An integer (0 to 255)
Remarks
In most windowing environments, a “palette” is typically available from which a color choice can be made. Depending on your system, the palette may have as few as 16, or as many as 16 million, colors.
When you specify a custom RGB (red, green, blue) color, Zim looks for the closest-matching color already in use. As a result, the match may not be exact.
See Also
Predefined color constants, BC, FC, WdgFCBlue
English 
Portuguese