VA FileMan V. 22.0 Programmer Manual Banner


 

Main Chapter Getting Started Manual Advanced User Manual

Classic VA FileMan API


EN^DIWE: Text Editing

This routine is used to edit word processing text using VA FileMan's editors. If the user has established a Preferred Editor through Kernel, that editor is presented for use. FileMan's editors expect the text to contain only printable ASCII characters.

Input Variables
DDWAUTO

(Optional) This variable can be set to an interval in minutes that the Screen Editor should automatically save the text for the user. It can be an integer between 1 and 120. If set to 0, no autosave occurs. The setting takes effect for only the current invokation of the Screen Editor and can be changed by the user via the <PF1><PF1>S key sequence. The default value of DDWAUTO is 0. This variable is killed by FileMan.

DDWTAB

(Optional) This variable indicates to the Screen Editor the initial tab stop positions. The setting takes effect for only the current invokation of the Screen Editor and can subsequently be changed by the user via the <PF1><PF1><Tab> key sequence.

To set individual tab stops, set DDWTAB to a series of numbers separated by commas; for example,

    DDWTAB = "4,7,15,20"

sets tab stops at columns 4, 7, 15, and 20. To set tab stops at repeated intervals after the last stop, or after column 1, type the interval as +n; for example,

    DDWTAB = "10,20,+5"

sets tab stops at columns 10, 20, 25, 30, 35, etc.

If not passed, the Screen Editor assumes DDWTAB = "+8"; that is, it initially sets tab stops at columns 1, 9, 17, 25, etc. This variable is killed by FileMan.

DIC

The global root of where the text is located.

NOTE: VA FileMan uses ^UTILITY($J,"W") when EN^DIWE is called. Thus, DIC should not be set equal to that global location.

DWLW

(Optional) This variable indicates the maximum number of characters that will be stored on a word-processing global node. When the user enters text, the input line will not be broken to DWLW-characters until after the Enter/Return key is pressed. Thus, if DWLW=40 and the user types 90 characters before pressing the Enter/Return key, the text would be stored in three lines in the global. If this variable is not set, the default value is 245. This variable is always killed by FileMan.

DWPK

(Optional) This variable determines how lines that are shorter than the maximum line length (set by DWLW) are treated by FileMan. It can be set to 1 or 2. This variable is always killed by FileMan.

DWPK=1

If the user enters lines shorter than the maximum line length in variable DWLW, the lines will be stored as is; they will not be joined. If lines longer than DWLW are entered, the lines will be broken at word boundaries.

DWPK=2

If the user types lines shorter than the maximum line length in variable DWLW, the lines will be joined until they get to the maximum length; the lines are "filled" to DWLW in length. If the lines are longer than DWLW, they will be broken at word boundaries. This is the default used if DWPK is not set prior to the EN^DIWE call.

NOTE: DWLW and DWPK only have an effect if text is entered using the Line Editor. They do not affect how text is stored if the Screen Editor or some other Alternate Editor is used.

DWDISABL New/Updated with VA FileMan V. 22.0This variable can be used to disable specific Line Editor commands. For example, if DWDISABL contains "P", then the Print command in the Line Editor is disabled. This variable is killed by FileMan. (Optional)
DIWEPSE

(Optional) If this variable is defined before entering the Preferred Editor (if the Preferred Editor is not the Line Editor), the user receives the following prompt:

    Press RETURN to continue or '^' to exit:

Set this variable if you want to allow the user to read information on the screen before the display is cleared by a screen-oriented editor. This variable is always killed by FileMan.

DIWESUB

(Optional) The first 30 characters of this variable are displayed within angle brackets (< and >) on the top border of the Screen Editor screen. This variable is killed by FileMan.

DIWETXT

(Optional) The first IOM characters of this variable are displayed in high intensity on the first line of the Screen Editor screen. This variable is killed by FileMan.

DDWLMAR

(Optional) This variable indicates the initial column position of the left margin when the Screen Editor is invoked. The user can subsequently change the location of the left margin. This variable is killed by FileMan.

DDWRMAR

(Optional) This variable indicates the initial column position of the right margin when the Screen Editor is invoked. The user can subsequently change the location of the right margin. This variable is killed by FileMan.

DDWRW

(Optional) This variable indicates to the Screen Editor the line in the document on which the cursor should initially rest. This variable has effect only if the user's preferred editor is the Screen Editor and applies only when the Screen Editor is first invoked. If the user switches from the Screen Editor to another editor and then back to the Screen Editor, the cursor always rests initially on line 1.

If this variable is set to "B", the cursor will initially rest at the bottom of the document and the value of DDWC described immediately below is ignored. The default value of DDWRW is 1. This variable is killed by FileMan.

DDWC

(Optional) This variable indicates to the Screen Editor the initial column position of the cursor. The same restrictions described above for DDWRW apply to DDWC.

If this variable is set to "E", the cursor will initially rest at the end of the line defined by DDWRW. The default value of DDWC is 1. This variable is killed by FileMan.

DDWFLAGS New/Updated with VA FileMan V. 22.0 Flags to control the behavior of the Screen Editor. The possible values are:
M Indicates that the Screen Editor should initially be in NO WRAP Mode when invoked.
Q Indicates that if the user attempts to Quit the editor with <PF1>Q, the confirmation message "Do you want to save changes?" is NOT asked.
R Indicates that the Screen Editor should initially be in REPLACE mode when invoked.
This variable is killed by FileMan. (Optional)

 


Reviewed/Updated: March 4, 2007