wrap Parameter

Wraps elements for the display.

Scope: Element

Syntax

query wrap 
set wrap { on | off | inverse | default } 

Options

on 
Wraps the elements.
off 
Does not wrap elements. This is the default value.
inverse 
Toggles between on and off.
default 
Display wrap is controlled by the value of the default parameter.

Description

The wrap on parameter ensures that elements wrap from one line to the next if the formatted line is longer than the formwidth. The wrap parameter must be set to on to spill elements at either the formwidth or spill lengths. If spill is set, it wraps at the lower of the two lengths.

The wrap parameter setting can also be changed by the Wrap setting choice, found in the pull-down menu for the View menu bar 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 in the pull-down menu for the View menu bar choice.

If the value of the wrap parameter is default, display wrap is controlled by the value of the default parameter.

Examples

  1. To set the wrap parameter on, type:
    set wrap on 
  2. To control display wrap with the value defined by the default parameter, type:
    set wrap default 
  3. To display the value of the wrap parameter, type:
    query wrap 

    If this query returns DEFAULT, type the following:

    query default.wrap

API Return Codes

-12 
This command requires an open document. First open a document then issue the command.
-2 
The option you specified was not on, off, or inverse. Issue the set command again using one of these options.

default parameter
formatter Parameter
formwidth Parameter
spill Parameter