MASK - Set the Insert line model






The MASK line command displays the =MASK> line.  On this line, you can type characters that you want to have automatically inserted into a file. These characters, which are called the mask, are inserted whenever you use the I (insert) or TS (text split) line commands.


The default initial value for the mask line is blank. Whenever you create a new PROFILE for a new file type, the mask value is always initially set to blank.

To define a non-blank mask:

Once a mask is defined, the contents of the =MASK> line are displayed whenever a new line is inserted.  This occurs when you use the I (insert) and TS (text split) line commands. You can change the mask definition whenever you wish by repeating the preceding steps.

The mask line is not saved as part of the data nor as part of the STATE information, since it is associated with a file's type as part of the PROFILE, and is not stored with any individual data file.

The mask remains in effect whether it is being displayed or not.

When you type MASK in the line command area, =MASK> is displayed in the sequence area, along with any previously defined mask line.

To remove the =MASK> line, use the D (delete) line command or the RESET primary command, or end the edit session.   When you delete the MASK with a D line command or with a RESET primary command, you are merely causing the display of the MASK line to go away; it does not remove the definition of the MASK line itself.

Technically, for any given file type, there is always a MASK definition present.  The only question is whether it is blank or not.

The =MASK> line data is saved as part of the PROFILE data for the file type.  

The MASK line provides a model text line which will be used to fill in newly inserted lines in the edit session created by the I or TS line commands.

Using inserted lines with MASK data

The data you define on the MASK line acts like a "prototype" or "overlay" of what each new inserted line will look like.  A common use for MASK lines is to insert comments on one side of a source program as new lines of code are written.

It is necessary that you type some original data on such inserted lines, in addition to what the MASK line specifies, even when the MASK line is non-blank.  If you don't, SPFLite will assume it's a temporary "blank" line that you don't want, and it will remove it.  Any non-blank characters on a MASK line are not considered original data in and of itself.


If you request display of the MASK line, and fill it in with the follows:

/*                                         */

then when new lines are inserted, those inserted lines would be initialized using the provided MASK prototype line, like this:

Created with the Personal Edition of HelpNDoc: Full-featured multi-format Help generator