flow Parameter

Controls the automatic flowing of elements.

Scope: View

Syntax

query flow 
set flow [LevelNumber] 

Option

LevelNumber 
The level at which elements are to be flowed. The default is 100.

Description

The flow parameter causes elements of a level number equal to or greater than the LevelNumber to flow together in the document window. This gives a formatted appearance to the document.

Note: You must set the formatter parameter to on for the flow parameter to have an effect on displayed text.

Examples

The lines below have not been flowed together.

line 1111111111 1111          (level 1)
 line 22222222222222          (level 2)
  line 33333333333333         (level 3)
   line 44444444444444        (level 4)
    line 55555555555555       (level 5)

To flow together elements at or below the third level, type:

set flow 4 

The elements of level 4 and 5 are flowed together on to the previous level, as shown below:

line 1111111111 1111 
 line 22222222222222 
  line 33333333333333line 44444444444444line 55555555555555 
Note: Indentation spaces will be represented by a fill character. The default fill character is a period, but you can define your own fill character by using the fill parameter. In the examples above, the fill character is defined to be a blank.

API Return Code

-12 
This command requires an open document. First open a document then issue the command.
-2 
The number specified was outside the valid range or was not a whole number. Issue the command again using a valid number.

fill Parameter
formatter Parameter
indent Parameter
overhang Parameter