Print Page as PDF
ScreenMan API: Form Utilities ICR (10150)

ScreenMan API: Form Utilities    ICR (10150)

Name Value
NUMBER 10150
IA # 10150
DATE CREATED 1994/06/24
CUSTODIAL PACKAGE VA FILEMAN
CUSTODIAL ISC San Francisco
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE DDSUTL
NAME ScreenMan API: Form Utilities
ORIGINAL NUMBER 10150
GENERAL DESCRIPTION
Help Messages: HLP, MSG; Refresh Screen: REFRESH;
Run-Time Field Status: REQ, UNED Utilities.
STATUS Active
ID DDSUTL
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
HLP()
This procedure prints messages in the Command Area.

Formats HLP^DDSUTL(STRING) HLP^DDSUTL(.STRING)
VARIABLES TYPE VARIABLES DESCRIPTION
STRING Input
(Required) The message to print in the Command Area.
.STRING Input
(Required) An array of messages to print in the
Command Area. STRING(1), STRING(2), ..., STRING(n) each contain a line of
text.
MSG()
This procedure prints Data Validation messages on a
separate screen.

Formats MSG^DDSUTL(STRING) MSG^DDSUTL(.STRING)
VARIABLES TYPE VARIABLES DESCRIPTION
STRING Input
(Required) The message to print in the Command Area.
.STRING Input
(Required) An array of messages to print in the
Command Area. STRING(1), STRING(2), ..., STRING(n) each contain a line of
text.
REFRESH
This entry point repaints all pages on the screen.

You can use this entry point only within a ScreenMan form, and only in:

Field level Pre Action Field level Post Action Field level Branching Logic
Field level Data Validation Format REFRESH^DDSUTL
None
REQ()
This procedure changes the REQUIRED property of a
field on the form.

Format REQ^DDSUTL(FIELD,BLOCK,PAGE,VALUE,IENS)
VARIABLES TYPE VARIABLES DESCRIPTION
FIELD Input
(Required) The Field Order number, Caption, or Unique
Name of the field.
BLOCK Input
(Required at the page and form levels) The Block
Order or Block Name. The default is the current block.
PAGE Input
(Required at the form level) The Page Number or Page
Name. The default is the current page.
VALUE Input
(Required) The value to give the REQUIRED property,
listed as follows:  "" Restore the REQUIRED property to the value defined in
the Block file.  0 Make the field not required.  1 Make the field required.
IENS Input
(Required at the page and form levels) The standard
IENS that identifies the entry or subentry associated with the form-only
field. The default is the current entry or subentry.
UNED()
This procedure changes the DISABLE EDITING property
of a field on the form.

Format UNED^DDSUTL(FIELD,BLOCK,PAGE,VALUE,IENS)
VARIABLES TYPE VARIABLES DESCRIPTION
FIELD Input
(Required) The Field Order number, Caption, or Unique
Name of the field.
BLOCK Input
(Required at the page and form levels) The Block
Order or Block Name. The default is the current block.
PAGE Input
(Required at the form level) The Page Number or Page
Name. The default is the current page.
VALUE Input
(Required) The value to give the DISABLE EDITING
property, shown below:

"" Restore the DISABLE EDITING property to the value as defined in the Block
file.  0 Enable editing, and allow the user to navigate to the field.  1
Disable editing, and prevent the user from navigating to the field.  2 Disable
editing, but allow the user to navigate to the field.
IENS Input
(Required at the page and form levels) The standard
IENS that identifies the entry or subentry associated with the form-only
field. The default is the current entry or subentry.