| # | Name | Location | Type | Details | Index | Description |
|---|---|---|---|---|---|---|
| .01 | name(+) | 0;1 | FREE TEXT | B | This field contains the name of the list. The list name should be namespaced and unique. | |
| .02 | type of list | 0;2 | SET OF CODES | 1:PROTOCOL 2:DISPLAY 3:SELECT (NOT AVAILABLE) | This field indicates the type of list. A 'protocol' list will cause the List Manager to use the PROTOCOL entered in the 'PROTOCOL MENU' field. A 'display' list will use the standard VALM DISPLAY protocol supplied by the List Manager. This protocol allows user to view or scroll though the list. The user will be able to use the standard 'next screen', 'previous screen',etc. actions. A 'select' list is similar to the 'display' list but will also allow the user to 'select' entries. The application will then use the selected entries in its processing This type of list is not currently available. | |
| .03 | left margin | 0;3 | NUMERIC | This field contains the left column of the scrolling region where the list will be displayed. Currently(11/91), this parameter is not used. | ||
| .04 | right margin | 0;4 | NUMERIC | This field indicates the maximum number of characters a row can contain. Currently(11/91), this parameter is not used. EE | ||
| .05 | top margin | 0;5 | NUMERIC | This field contains the number of the top row of the scrolling region where the list will be displayed. | ||
| .06 | bottom margin | 0;6 | NUMERIC | This field contains the number of the bottom row of the scrolling region where the list will be displayed. | ||
| .07 | ok to transport? | 0;7 | SET OF CODES | 0:NOT OK 1:OK | This field indicates to the transport utility if this list template should be distributed. | |
| .08 | use cursor control | 0;8 | BOOLEAN | 0:NO 1:YES | This field indicates whether the cursor positioning and character enhancements capabilities of the device should be used. If set to 'NO', then lists will be presented in scrolling mode. For some actions, like 'up one entry', this would increase use of system resources. If set to 'YES', then list will be presented using the terminal type's capabilities. However, if the user signs on to a device that is not adequately defined in the TERMINAL TYPE file, then the list will automatically display in scrolling mode. | |
| .09 | entity name | 0;9 | FREE TEXT | This field contains the term that will be displayed to the user that best describes the items in the list. The term will be used if the developer wishes to use the generic 'select' action. For example, "Select Appointment(s):" could be displayed and the entity is 'Appointment'. The term will be used in other displays as well. | ||
| .1 | protocol menu | 0;10 | FREE TEXT | This field contains the name of the PROTOCOL that will be used by the List Manager if the the TYPE OF LIST is 'protocol'. This field is not used for 'display' or 'select' types. | ||
| .11 | screen title | 0;11 | FREE TEXT | This field contains the text that will be display/printed in the upper left corner of the screen display. | ||
| .12 | allowable number of actions | 0;12 | NUMERIC | This field indicates the number of actions a user can select at one time. For example, if this parameter is set to 1 then the user can only enter one action... Select Action: NX ...and the following would not be allowed: Select Action: NX,EP If this parameter is not entered then the system defaults to 1. | ||
| .13 | date range limit | 0;13 | NUMERIC | This field contains the maximum number of days that can be specified by the user while entering a date range. This parameter is only used if the application calls the List Manager's date range selection utility. | ||
| .14 | automatic defaults | 0;14 | BOOLEAN | 0:NO 1:YES | This field indicates whether List Manager should always supply a default action at the 'Select' prompt for 'Protocol' type List Templates. If set to 'NO', a default will not be provided automatically. It will be the developer's responsibility to indicate a default, if desired. This default can be indicated by setting XQORM("B") as part of the protocol menu's HEADER code. (i.e. D SHOW^VALM S XQORM("B")="Your action") This parameter only is valid for 'Protocol' type List Templates. If the parameter is set to 'YES' or is blank, a default will be provided by List Manager. If the current screen contains the last line in the list, then the default will be 'Quit'. Otherwise, it will be "Next Screen". However, as discussed above, the developer can override this default by setting XQORM("B"). | |
| 1.01 | print list protocol | 1;1 | FREE TEXT | This field contains the name of the protocol that will be called when the user selects the generic 'Print List' action. Normally, this field is blank and the generic printing action is sufficient. | ||
| 1.02 | hidden action menu | 1;2 | FREE TEXT | This field contains the name of the protocol menu that will be used by the List Manager for the 'hidden' actions available to the user. Normally, the application enters the 'VALM HIDDEN ACTIONS' menu in this field. However, there maybe applications that would require a different set of 'hidden' actions. | ||
| 100 | header code | HDR;E1,245 | FREE TEXT | This MUMPS field contains the code that the List Manager will execute to print the application specific screen header. | ||
| 102 | expand code | EXP;E1,245 | FREE TEXT | This field contains the MUMPS code that displays a detail inquiry-type report/screen for a specific entry in the list. | ||
| 103 | help code | HLP;E1,245 | FREE TEXT | This field contains the MUMPS code for the help that will appear when the user types '?' at the 'Select Action:' prompt. This field is optional. If not defined, the normal help given by the XQOR* driver will take affect. | ||
| 105 | exit code | FNL;E1,245 | FREE TEXT | This field contains MUMPS logic that will be executed by the List Manager when the user exits the list. The code is usually used to clean up the partiton and kill any temporary globals used during the List Manager call. After this code is executed, the List Manager will clean up the variables and temporary globals it set. This field is optional. | ||
| 106 | entry code | INIT;E1,245 | FREE TEXT | This field contains MUMPS code that is executed when then List Manager is called. This code is usually used by the application to initialize variables. This field is optional. | ||
| 107 | array name | ARRAY;E1,50 | FREE TEXT | This field contains the name of the array that holds the list of items to be displayed. The array name must be preceded by a space character. This is needed to allow global specifications. (File Manager will not allow '^' as the first character.) The array can be either a local or global variable. | ||
| 200 | caption line columns | COL;0 | MULTIPLE | 409.621 | This multiple field contains column definitions for
the data displayed in the list. Adding entries to
this multiple is optional.
The column parameters are used when the List Manager
writes the line indicating the top of the list's
scrolling region.
If no entries are added then only a line is written
with no captions.
The parameters are also used by special function calls
that an application is allowed to used. For example,
there is a function at FLDUPD^VALM1 that can be used
to update the screen. The function will change the value
of a column for a particular entry.
[$$FLDUPD^VALM1( |
Not Referenced