Print Page as PDF
VALM10 ICR (10117)

VALM10    ICR (10117)

Name Value
NUMBER 10117
IA # 10117
CUSTODIAL PACKAGE VETERANS ADMINISTRATION
CUSTODIAL ISC Albany
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE VALM10
NAME VALM10
ORIGINAL NUMBER 10117
STATUS Active
ID VALM10
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION
FLDTEXT
*      FLDTEXT^VALM10(LINE, FIELD, STRING) This
sub-routine inserts the text STRING at the column where the specific field
starts in a LINE in the list array.

The FIELD name must match a field defined in the CAPTION LINE COLUMNS multiple
of the LIST TEMPLATE file.

INPUT: LINE   := line number FIELD  := column. name STRING := string to insert
SET
*      SET^VALM10(LINE, STRING, ENTRY#) This
sub-routine will set the LINE in the array equal to the text STRING. If the
List Template does not define an ARRAY NAME, then this call must be used to
build lines in the array.

INPUT: LINE   := line number STRING := string to for array line ENTRY# :=
entry number associated with the line(if
passed, then line will also be indexed for use by the
EN^VALM2 selection utility.) [optional]
CNTRL
*      CNTRL^VALM10(LINE, COLUMN, WIDTH, ON, OFF,
SAVE) This subroutine allows the developer to indicate video attributes for
text in a list.

INPUT: LINE           := line number COLUMN                 := column where
code should be invoked WIDTH          := how many columns should the code be
in effect for ON             := beginning control sequence OFF            :=
ending control sequence SAVE           := 1 to save control sequence for later
use
otherwise 0 [optional]
KILL
*      KILL^VALM10(LINE) This subroutine deletes
video attributes. If LINE is not defined then all video attributes for a List
Template will be deleted. If LINE is defined then only the attributes for that
line are deleted.

INPUT: LINE   := line number
SAVE
*      SAVE^VALM10(LINE) This subroutine saves the
current video attributes for the indicated line.

INPUT: LINE   := line number
RESTORE
*      RESTORE^VALM10(LINE) This subroutine restores
the video attributes that have been saved for the indicated line.

This subroutine does not re-write the line to the screen. The subroutine
WRITE^VALM(LINE) should be used to actually write the line.

INPUT: LINE   := line number
SELECT
*      SELECT^VALM10(LINE, MODE) This subroutine will
highlight/unhighlight a line in the list. The call will set up or delete the
proper video controls and then 'writes' the line to the screen.

The 'line' passed to this call must currently be displayed on the screen.


INPUT: LINE   :=      line number MODE   :=      1 to highlight
0 to unhighlight and restore to original state
WRITE
*      WRITE^VALM10(LINE) This subroutine will
re-write the line to the screen.

INPUT: LINE   := line number
FLDCTRL
*      FLDCTRL^VALM10(LINE, FIELD, ON, OFF, SAVE)
This subroutine will set up the appropriate video control sequences for a LINE
in the list array based on the DEFAULT VIDEO ATTRIBUTES in the CAPTION LINE
definition for the template.

If FIELD is passed, then only the video attributes defined for that field will
be set up.

If ON is defined, then code in ON will be used for the video attributes
instead of the default.

If OFF is defined, then code in OFF will be used for the video attributes
instead of the default.

INPUT: LINE   := line number FIELD  := column name [optional] ON     :=
beginning control sequence [optional] OFF    := ending control sequence
[optional] SAVE   := 1 to save control sequence for later use
otherwise 0 [optional]
CLEAN
*      CLEAN^VALM10 This subroutine will kill the
data and video control arrays associated with the active List template.

This call is commonly used to kill the array related data before re- building
the array.
MSG
*      MSG^VALM10(MESSAGE) This call allows the
developer to immediately post a message to the 'message window' located in the
lower frame bar of the List Manager display screen.

INPUT: MESSAGE        := Text up to 50 characters.  OUTPUT: [none]

To turn off the custom message and re-display List Manager's standard message,
make a call to MSG^VALM10 with the null string as the message[e.g. D
MSG^VALMSG("")].

To display a custom message when List Manager re-displays the screen after an
action is performed, set the variable VALMSG to the desired message text.