Category: Front End Development

MENU DEFINE

Invokes Zim IDE to edit a menu.

Syntax

MENU DEFINE menuname [[IN] dirname]

Parameters

menuname

The name of a new or existing menu.

dirname

The name of the application directory in which the specified menu can exist. If the menu does not exist in the provided application directory, it will be created there.

If omitted:

the menu will be selected from the first application directory in which it exists.

if the menu does not exist, it will be created in the ZIM application directory.

Examples

Invokes Zim IDE to edit the menu mAddEmps:

 

menu define mAddEmps

If mAddEmps does not exist in any application directory, it will be created in the ZIM application directory.

Otherwise, it will be selected from the first application directory in which it exists.

 

menu define mAddEmps ZIM

If mAddEmps does not exist in the ZIM application directory, it will be created there.

It will be selected from the ZIM application directory only if it exists there.

 

menu define mAddEmps EMPS

If mAddEmps does not exist in the EMPS application directory, it will be created there.

It will be selected from the EMPS application directory only if it exists there.

 

Related topics

DISPLAY DEFINE

FORM DEFINE

WINDOW DEFINE

FORM DEFINE

Invokes Zim IDE to edit a form.

Syntax

FORM DEFINE formname [[IN] dirname]

Parameters

formname

The name of a new or existing form.

dirname

The name of the application directory in which the specified form can exist. If the form does not exist in the provided application directory, it will be created there.

If omitted:

the form will be selected from the first application directory in which it exists.

if the form does not exist, it will be created in the ZIM application directory.

Examples

Invokes Zim IDE to edit the form fAddEmps:

form define fAddEmps

If fAddEmps does not exist in any application directory, it will be created in the ZIM application directory.

Otherwise, it will be selected from the first application directory in which it exists.

form define fAddEmps ZIM

If fAddEmps does not exist in the ZIM application directory, it will be created there.

It will be selected from the ZIM application directory only if it exists there.

form define fAddEmps EMPS

If fAddEmps does not exist in the EMPS application directory, it will be created there.

It will be selected from the EMPS application directory only if it exists there.

Related topics

DISPLAY DEFINE

MENU DEFINE

WINDOW DEFINE

WINDOW DISPLAY

Controls the display of windows on the screen.

Syntax

WINDOW DISPLAY [window] [EXPOSE|HIDE]

Parameters

window

Window can be
name
The name of an open window. The software looks up the value of name in the currently accessed directories in the usual way. A compiled command using name contains the unambiguous name of the window (including a reference to an application directory) that was found at compile time.
(expr )
A character string, or an expression that evaluates to a character string, that is to be used at run time as a window object name. The parentheses must be entered.
A compiled command using (expr) can refer to many windows, at the risk of encountering an ambiguous window name (i.e., no directory specified when versions of the window are available in two or more directories).
If neither name nor (expr) is specified, the current window is assumed.

EXPOSE

Specifies that the window is to be displayed over any other active windows already on the screen. This is the default.

HIDE

Specifies that the window is to be displayed beneath any other active windows already on the screen.

Comments

The WINDOW DISPLAY command enables an application program to lift a particular window atop other active windows (using EXPOSE) or to drop the window below all other active windows (using HIDE).

An application user can also lift a window by interacting with it.

Example

To display the window wHelp underneath the other active windows:

window display wHelp hide

 

See Also

ThisWindow

WINDOW ACTIVATE

WINDOW CLEAR

WINDOW CLOSE

WINDOW DEACTIVATE

WINDOW MOVE

WINDOW OPEN

WINDOW SCROLL

WINDOW SET

WINDOW SIZE

FORM SET SCROLL

Establishes a scrolling association between a form and a result set.

Syntax

FORM SET SCROLL [ NOCLEAR] form FROM set [LET clause] [EVALUATE clause]

Parameters

NOCLEARSpecifies that form is not to be immediately initialized with data from set.
formThe form through which records are to be scrolled. Form must be open in the current window; it can be a multi-instance form in a display object.
setA result set whose records are to be scrolled through form.

Comments

The current member of set is placed in the first instance of form. Subsequent members of set are placed in subsequent instances of form (if any).

Although many scrolling relationships can exist at one time, one set cannot have a scrolling relationship with more than one form at a time.

The application user scrolls the form through the records in set by moving the focus to the form and pressing a SCROLL key. If the focus is not located in an active scrolling form, but active scrolling forms exist in the display, then pressing a SCROLL key causes all active scrolling forms to scroll over their associated sets.

Example

To establish a scrolling relationship between the fEmps form and the result set EmpSet, enter

find all Employees where Location="New York" sorted by Name -> EmpSet
form open dEmps
form set scroll fEmps from EmpSet

See Also

FORM SCROLL
FORM SET

FORM SAVE

Saves the current form or display in its current state for later use in the current Zim window.

Note: This command is invalid in Zim version 5 and above.

Syntax

FORM SAVE

Comments

This command should be used to preserve only dynamic changes to form field attributes (made using FORM SET(Attributes) commands) across FORM OPEN commands in the same window, when the current form or display in its current state is required at some later time.

Many forms and/or displays can be saved. When the FORM SAVE command is executed, the current form or display is pushed onto the stack of previously saved forms. Afterwards, no form or display is considered to be open in the window.

Saved forms or displays can be “popped” off the “stack” one at a time, using the FORM RESTORE command, to become the current form or display.

Note: The FORM SAVE command must only be used with forms that are selected in text windows – never forms in graphical windows. Use of this command in Zim for Windows can cause system termination.

Example

form open fEmployees

form set (protected) fEmployees.Salary  %Salary protected from edit

form display input

… processing commands – error detected…

form save

form open fErrorMsg

form display noclear

… processing commands …

form open fEmployees NoClear           % Salary is still protected

form display

When an input error occurs, the form is saved in its current state, then an error message is displayed over the form on the screen. The form is later restored and displayed as it existed at the time of the FORM SAVE.

 

See Also

FORM CLEAR

FORM DISPLAY

FORM INPUT

FORM OPEN

FORM REPORT

FORM RESTORE

FORM SCROLL

FORM SET

WINDOW SET ACCELERATOR

Establishes the accelerators for the current window.

Syntax

WINDOW SET [ ADD|NOT] ACCELERATOR [ «keyname»]

Parameters

ADDSpecifies that keyname is to be added to the current list of accelerator keys.
NOTSpecifies that keyname is to be removed from the current list of accelerator keys.
keynameCan be any of the pre-defined key names:
F1 through F100, ESCAPE, RETURN, ENTER, UP, DOWN, LEFT, RIGHT, PAGEUP, PAGEDOWN, HOME, END,
JUMPUP (Ctrl-Up), JUMPDOWN (Ctrl-Dn),
JUMPLEFT (Ctrl-Lf), JUMPRIGHT (Ctrl-Rt),
TABBACK (Shift-Tab), TABFORWARD (Tab)
or any of the pre-defined mouse button names (used in ZIM Version 4 windows only):
BUTTON1 through BUTTON6
If keyname is a character string that does not match any pre-defined key name, each character in the string becomes an accelerator key.

Comments

Each window has its own current list of accelerator keys. Before a WINDOW SET ACCELERATOR command is issued, no accelerator keys are in effect.

Any combinations of key names can be specified as accelerator keys. Mouse button names are valid key names.

If neither ADD nor NOT is specified, then keyname replaces the current list of accelerator keys. If no keyname is specified, then all accelerator keys are disabled.

An accelerator key causes an event that is intercepted by the program. Event.EventType is assigned “Accelerator”, and Event.EventName is assigned the name of the key.

Accelerator keys are ignored if the focus is in a menu.

See Also

FORM INPUT

MENU INPUT

ThisWindow

WINDOW OPEN

WINDOW OPEN

Opens a window for use in subsequent window-handling commands.

Syntax

WINDOW OPEN [window] [AT position] [SIZE winsize] [FOR form] [IN parent]

Parameters

windowWindow can be:
name
The name of the window that you want to open. Zim looks up the name in the currently accessed directories in the usual way. A compiled WINDOW OPEN command using name contains the unambiguous name of the window (including a reference to an application directory) that was found at compile time.
(expr)
A character string or an expression that evaluates to a character string that is to be used at run time as the name of the window. The parentheses must be entered. A compiled WINDOW OPEN command using (expr) can refer to many windows, at the risk of encountering an ambiguous window name (i.e., no directory specified when versions of the window are available in two or more directories).
WINDOW OPEN cannot be used to open a window defined in a foreign directory.
positionPosition can be:
row col
Numbers or expressions that evaluate to numbers. Complex expressions must be enclosed in parentheses.
Specify the location of the window by explicitly setting the row and column in pixels for the upper left-hand corner of the window.
position
Specifies the position of the window by giving a general placement instruction. Can be TOP, TOP LEFT, TOP RIGHT, CENTER, LEFT, RIGHT, BOTTOM, BOTTOM LEFT, or BOTTOM RIGHT.
For pop-up windows, the specified location is relative to the screen. For clipped windows, the location is relative to the client area of the parent window.
winsizeSize can be:
height width
Numbers, or expressions that evaluate to numbers. Height identifies the height, in pixels, of the window’s client area; width identifies the width, in pixels, of the window’s client area.
MAXIMIZE
Opens a clipped window so that it fills the client area of parentwin, or a pop-up window so that it fills the screen.
MINIMIZE
Opens a clipped window so that it appears as an icon near the bottom, left-hand corner of parentwin, or a pop-up window so that it appears as an icon near the bottom left-hand corner of the screen.
formForm is the name of a form or display on which the logical dimensions of the window are based. Can be:
formname
Where formname is a form (or display) object name. The software looks up formname in the currently accessed directories in the usual way. A compiled WINDOW OPEN command using formname contains the unambiguous name of the form (including a reference to an application directory) that was found at compile time.
(expr)
A character string, or an expression that evaluates to a character string, that is to be used at run time as a form object name. The parentheses must be entered.
The name of the form is determined at run time. A compiled WINDOW OPEN command using (expr) can refer to many forms, at the risk of encountering an ambiguous form name (i.e., no directory specified when versions of the form are available in two or more directories).
The FOR clause overrides the default logical dimensions of the window object.
parentParent is the name of an open window that is to be the parent of the window being opened. The child window must have the attribute Clipped To Parent set. Can be:
name
The name of the parent window. The software looks up name in the currently accessed directories in the usual way. A compiled WINDOW OPEN command using name contains the unambiguous name of the window (including a reference to an application directory) that was found at compile time.
(expr)
A character string, or an expression that evaluates to a character string, that is to be used at run time as the name of the parent window. The parentheses must be entered.
A compiled WINDOW OPEN command using (expr) can refer to many windows, at the risk of encountering an ambiguous window name (i.e., no directory specified when versions of the window are available in two or more directories).

Comments

WINDOW OPEN opens the specified window and establishes its initial position and its physical and logical dimensions.

The window being OPENed becomes the current window, but it does not automatically appear on the screen. To appear on the screen, the window must be activated either explicitly by a WINDOW ACTIVATE command, or implicitly by an input request (e.g., FORM INPUT, INPUT, MENU INPUT).

WINDOW OPEN makes the window available for output. Forms can be open and displayed in the window, and output from commands such as REPORT FROM, LIST, OUTPUT, and so on, can be sent to the window. The output appears only when the window is activated.

If the AT clause is omitted, the window appears at the position defined for it in the Object Dictionary.

A window’s position is always relative to its physical parent. The physical parent of a clipped window is another window (parentwin). The physical parent of a pop-up window is the terminal.

If the arguments to the AT clause are such that the window opens out of bounds, the position is adjusted automatically so that the window remains entirely within the parent’s boundaries.

If the SIZE clause is omitted, the dimensions of the window’s client area are determined from the window’s definition in the Object Dictionary.

If either dimension in a SIZE clause is negative, the window is sized to maximize the associated dimension within parentwin with respect to the specified row and col position.

If the FOR clause is omitted, the logical dimensions of the window are determined from the window’s definition in the Object Dictionary.

If the IN clause is omitted, the newly opened window automatically becomes a “child” of the application window (BACKSCREEN).

The IN clause tells Zim to clip the window being opened to the parent, provided that the child window has the Clipped to Parent attribute set. Otherwise, the child window will be opened as usual.

WINDOW OPEN [re]sets the fields of the ThisWindow system variable.

See Also

$iswinopen

ThisWindow

WINDOW ACTIVATE

WINDOW CLEAR

WINDOW CLOSE

WINDOW DEACTIVATE

WINDOW DISPLAY

WINDOW SCROLL

WINDOW SET

WINDOW SIZE

FORM SET DYNAMICLIST

Dynamic Multi-Column List Box: Elevate Your Data Presentation

What is it?

Our Dynamic Multi-Column List Box is a versatile tool designed to display large datasets in a clean, organized, and interactive manner. Perfect for web applications that require efficient data handling and presentation.

Key Features

  1. Dynamic Data Loading: Fetches data on demand from your database, ensuring that the information displayed is always current and accurate.
  2. Multi-Column Support: Display multiple columns of data, each with customizable headings and content.
  3. User-Friendly Formatting:
    • Text Fields: Left-justified for easy reading.
    • Numeric Fields: Centered for a balanced look.
    • Column Headings: Always left-justified for consistency.
  4. Adjustable Column Widths: Easily modify column widths to fit your data perfectly using the $tocharacter(<fieldname>, length) function.
  5. Interactive Scrolling: Supports both horizontal and vertical scrolling, allowing users to navigate through large datasets effortlessly.

Technical Implementation

Syntax:

FORM SET DYNAMICLIST <formfield> FROM <setname>
FORMAT <expression1> [HEADING <expression2>]
[<expression1_n> [HEADING <expression2_n>]]

Parameters:

  • formfield: The form field in your web application, set up as a dynamic multi-column list box.
  • expression1: The content for the first column.
  • expression2: The heading for the first column.
  • expression1_n: The content for the nth column.
  • expression2_n: The heading for the nth column.

Example Use Case

Imagine you want to display a list of customers with their first and last names in a form called myform that includes a dynamic list box named dynalist. Here’s how you can set it up:

find all customers -> custset

form set dynamiclist myform.dynalist from custset format firstname lastname heading "SurName"

This setup will dynamically load and display the first and last names of all customers, with “SurName” as the heading for the last name column.

Why Choose Our Dynamic Multi-Column List Box?

  • Efficiency: Handles large datasets without compromising performance.
  • Flexibility: Customizable to fit your specific data presentation needs.
  • User Experience: Enhances user interaction with smooth scrolling and adjustable columns.

Upgrade your data presentation with our Dynamic Multi-Column List Box and provide your users with a seamless and interactive experience.

CHANGE

FORM DISPLAY

FORM INPUT

LET

WINDOW SCROLL

Scrolls an open window horizontally or vertically under application program control.

Syntax

WINDOW SCROLL [window] action

Parameters

windowWindow can be
name
The name of the window that you want to open. The software looks up name in the currently accessed directories in the usual way. A compiled WINDOW OPEN command using name contains the unambiguous name of the window (including a reference to an application directory) that was found at compile time.
(expr )
A character string, or an expression that evaluates to a character string, that is to be used at run time as the name of the window. The parentheses must be entered.
A compiled WINDOW OPEN command using (expr) can refer to many windows, at the risk of encountering an ambiguous window name (i.e., no directory specified when versions of the window are available in two or more directories).
WINDOW OPEN cannot be used to open a window defined in a foreign directory.
actionCan be
TO row col
UP n | DOWN n
LEFT n | RIGHT n
PAGEUP | PAGEDOWN
JUMPUP | JUMPDOWN
JUMPLEFT | JUMPRIGHT
HOME | END
In TO row col, row and col are integers or expressions that evaluate to integers. Complex expressions must be enclosed in parentheses. Row identifies the character row at which the top of the client area is to be positioned; col identifies the character column at which the left side of the client area is to be positioned. Valid values are 1 through the maximum number of rows or columns in the current window’s presentation space. A value of -1 for row or col indicates that no scrolling is to occur.
SCROLLING ACTIONSCROLL DIRECTION AND MAGNITUDE
UP nIn UP n, n is a number or an expression that evaluates to an number. Scrolls the window n rows up over its presentation space.
DOWN nIn DOWN n, n is a number or an expression that evaluates to an number. Scrolls the window n rows down over its presentation space.
LEFT nIn LEFT n, n is a number or an expression that evaluates to an number. Scrolls the window n columns left over its presentation space.
RIGHT nIn RIGHT n, n is a number or an expression that evaluates to an number. Scrolls the window n columns right over its presentation space.
PAGEUPPAGEUP scrolls the window one client-area-height up over its presentation space.
PAGEDOWNPAGEDOWN scrolls the window one client-area-height down over its presentation space.
PAGELEFTPAGELEFT scrolls left the current width of the client area.
PAGERIGHTPAGERIGHT scrolls right the current width of the client area.
JUMPUPJUMPUP scrolls the window one half a client-area-height up over its presentation space.
JUMPDOWNJUMPDOWN scrolls the window one half a client-area-height down over its presentation space.
JUMPLEFTJUMPLEFT scrolls the window one half a client-area-width left over its presentation space.
JUMPRIGHTJUMPRIGHT scrolls the window one half a client-area-width right over its presentation space.
HOMEHOME matches the top, left-hand corner of the client area to the top, left-hand corner of the presentation space.
ENDEND matches the bottom, right-hand corner of the client area to the bottom, right-hand corner of the presentation space.

Note: In all cases, n is a number, or an expression that evaluates to a number, indicating the number of character rows or character columns to scroll in the specified direction.

Comments

Under program control, the WINDOW SCROLL command scrolls the client area of the current window over its presentation space to enable the application user to see a part of the window contents that was not visible. The scrolling action occurs just as if the application user had initiated the same action.

See Also

ThisWindow

WINDOW ACTIVATE

WINDOW DISPLAY

WINDOW MOVE

WINDOW OPEN

WINDOW SET

WINDOW SIZE

FORM SET

Dynamically Modifying Form Attributes

Syntax #1: Changing Attributes of Open Forms or Fields

Command: FORM SET («option») «object»

Parameters:

  • option:
    • [NOT] ABBREVIATE, [NOT] AUTOCLEAR, [NOT] AUTOSKIP, [UN] AVAILABLE, [NOT] BOLD, [NOT] CLICK, [NOT] DOUBLECLICK, EVENT eventName, FILLCOLOR color, FONT fontname, [NOT] GOTFOCUS, GUARDED, [NOT] IMMEDIATELY REQUIRED, [IN]VISIBLE, [NOT] ITALIC, LABEL label, [NOT] LOSTFOCUS, [NOT] LOSTFOCUSMODIFIED, [NOT] MODIFIED, MOUSEPOINTER fileName, NORMAL, PENCOLOR color, POINTSIZE n, PROTECTED, [NOT] REQUIRED, RESET, [NOT] REVERSE, [NOT] RIGHTCLICK, [NOT] SCROLL, SCROLL LINE n, SCROLL MAX n, SCROLL MIN n, SCROLL PAGE n, [NOT] STRIKEOUT, [NOT] SUPPRESS, [NOT] VALIDATE, VERB verbName, VISIBLE, [NOT] UNDERLINE
    • Except for NORMAL and RESET, each option affects only one attribute.
  • object:
    • form: Name of an open form or display in the current window. Specify a particular instance by appending the instance number in brackets.
    • formfield: Name of a form field. Specify a particular instance by appending the instance number in brackets.
    • ([exp1], [exp2], [exp3]): Positive integers or expressions evaluating to positive integers, identifying a particular form or form field. exp1 identifies the form number; exp2, the field number; exp3, the instance of the form or form field.

Syntax #2: Applying Attributes to Form Fields with Focus

Command: FORM SET («option») CURSOR

Parameters:

  • option:
    • [NOT] BOLD, FILLCOLOR color, [IN]VISIBLE, [NOT] ITALIC, NORMAL, PENCOLOR color, [NOT] REVERSE, [NOT] STRIKEOUT, [NOT] SUPPRESS, [NOT] UNDERLINE
    • Except for NORMAL, each option affects only one attribute.
  • CURSOR: Options are dynamically added to a form field when it gains focus and restored to the previous appearance when it loses focus.

Comments

  • NORMAL: Sets objects to an unsuppressed, visible, and non-reversed condition.
  • RESET: Resets objects to their initial state when the forms were opened.
  • Scrollbars:
    • MIN and MAX values define the range of acceptable values.
    • LINE represents the amount of space the thumb “jumps” when arrows are clicked.
    • PAGE represents the size of the thumb, usually a percentage of one “line”.

Example Commands

  • Setting attributes of fields:
  form set (reset) fAddEmp.EmpNum
  form set (italic lostfocus) fAddEmp.EmpNum
  form set (not lostfocus) fAddEmp.EmpNum
  form set (lostfocus) fAddEmp.EmpNum
  form set (bold) cursor  % displays the focus field in bold font
  • Setting attributes of forms:
  form set (reset) fAddEmp[3]
  form set (italic) (2,,3)
  form set (not scroll not required lostfocus) fEmps
  • Setting scrollbar attributes:
  form set (scroll page 8) fFileDir.UpDnBar
  form set (scroll max 50) fFileDir.LfRtBar

See Also

  • FORM SET SCROLL
en_CAEnglish
pt_BRPortuguese en_CAEnglish