formatter Parameter

Turns formatting instructions on or off.

Scope: Global

Syntax

query formatter 
set formatter { on | off | inverse } 

Options

on 
Sets line formatting on.
off 
Sets line formatting off.
inverse 
Toggles between on and off.

Description

The formatter on parameter formats documents and uses information supplied by commands and parameters, such as indent, format, and wrap to format displayed text.

Formatted text can be saved as displayed by using the save command with the /asshown option.

When the formatter parameter is set to off, each element is displayed unformatted on a separate line.

The default setting for the formatter parameter is off.

The formatter parameter setting can also be changed by the Wrap setting choice. Selecting the Wrap setting sets both the formatter and wrap parameters to on, and the formwidth parameter to 0. Deselecting this choice sets the formatter and wrap parameters to off. The formwidth parameter is not changed, and retains its value of 0.

Conversely, setting both the formatter and wrap parameters to on, and the formwidth parameter to 0, will select the Wrap setting choice.

Example

The following is an example of a document with wrap on, formwidth=30, and formatter set to off:

  At that very moment, Jack knew he was on a very hot lap:  in
fact he was about to set a new lap record and in the process win 
his class and the overall Solo 1 championship - here comes the flag!

To format the document, type:

set formatter on 

The document appears like this with formatter on:

  Just then her head struck 
  ..against the roof of the 
  ..hall:  in
fact she was now more than 
..nine feet high, and she at 
..once took 
up the little golden key and 
..hurried off to the garden 
..door.
Note: Indentation spaces will be represented by a fill character. The default fill character is a period, as shown in the example above. You can define your own fill character using the fill parameter.

API Return Code

-2 
An invalid parameter option was specified.

fill Parameter
flow Parameter
format Parameter
formwidth Parameter
indent Parameter
overhang Parameter
wrap Parameter