spill Parameter

Sets the formatting width for elements to spill over to a new line.

Scope: View

Syntax

query spill 
set spill Width 

Option

Width 
The width in characters at which a new line begins for an element that spills over. Valid values are integers between 20 and 2500 inclusive. The default value is 72.

Description

The spill parameter sets the width at which spillover elements are formatted. If an element, whose format includes the spill option, is longer than the spill width, the line ends at a blank and a new line is started. If spill is larger than formwidth, it has no effect. The wrap parameter must be set to on for spill to take effect.

Examples

Suppose you have a text file that contains some elements you want to spill at a length less than formwidth (set at 72 characters). For each of these elements, use the format parameter to assign the format spill option. Then, to set the width of these elements to 60 characters, type:

set formwidth 72 
set spill 60 

API Return Code

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

format Parameter
formwidth Parameter