Print Page as PDF
Browser API ICR (2607)

Browser API    ICR (2607)

Name Value
NUMBER 2607
IA # 2607
DATE CREATED 1998/10/14
CUSTODIAL PACKAGE VA FILEMAN
CUSTODIAL ISC San Francisco
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE DDBR
NAME Browser API
GENERAL DESCRIPTION
The Browser displays ASCII text on a terminal which
supports a scroll region.
STATUS Active
ID DDBR
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
EN
This is an interactive procedure that asks the user
for:

File
Word Processing Field
Entry

and then displays the text.
None
WP()
This procedure displays word processing fields, as
well as allowing navigation throughout the text, in a FileMan-compatible
database using FileMan's Browser facility.

Format WP^DDBR(FILE,IENS,FIELD,FLAGS,TITLE,LINE,TABS,TOP,BOTTOM)
VARIABLES TYPE VARIABLES DESCRIPTION
FILE Input
(Required) File or subfile number.
IENS Input
(Required) Standard IENS indicating internal entry
number string.
FIELD Input
(Required) Word processing field name or number.
FLAGS Input
N No copy of the document is made. The Browser will
use the source document. Useful for long static documents.

R Restrict switching.
TITLE Input
(Optional) Text that is centered in header. Document
title.
LINE Input
(Optional) The line in the document that would be at
the bottom margin of the opening screen.
TABS Input
(Optional) Closed array root, passed by value, that
is used to scroll horizontally. If not set, the Browser provides default tab
stops.
TOP Input
(Optional) A number representing the location of the
title bar of the Browser screen.
BOTTOM Input
(Optional) A number representing the location of the
status bar of the Browser screen.
BROWSE()
This procedure enables the user to utilize FileMan's
Browser to view and navigate through a document stored in a sequential local
or global array.

Format BROWSE^DDBR(SOURCE_ARRAY,FLAGS,TITLE,LINE,TABS,TOP,BOTTOM)
VARIABLES TYPE VARIABLES DESCRIPTION
SOURCE_ARRAY Input
(Required) Source array in a closed root format,
passed by value which is the location of a sequential local or global array
containing text.
FLAGS Input
(Optional) Flags to control processing are described
below:

N No copy of the document is made. The Browser will use the source document.
Useful for long static documents.

R Restrict switching.
TITLE Input
(Optional) Text centered in screen title.
LINE Input
(Optional) The line in the document that would be at
the bottom margin of the opening screen.
TABS Input
(Optional) Closed array root, passed by value; used
to scroll horizontally. If not set, the Browser provides default tab stops.
TOP Input
(Optional) A number representing the location of the
title bar of the Browser screen.
BOTTOM Input
(Optional) A number representing the location of the
status bar of the Browser screen.
DOCLIST()
This procedure call allows passing more than one
document to the Browser facility.

Format DOCLIST^DDBR(SOURCE_ARRAY,FLAGS,TOP,BOTTOM)
VARIABLES TYPE VARIABLES DESCRIPTION
SOURCE_ARRAY Input
(Required) Source array in a closed root format,
passed by value which is subscripted by document titles and set to the source
array of the document in a closed root format.
FLAGS Input
(Optional) Flag to control processing is described
below:

R Restrict Switching to other documents not in current list.
TOP Input
(Optional) A number representing the location of the
title bar of the Browser screen.
BOTTOM Input
(Optional) A number representing the location of the
status bar of the Browser screen.