Sets the formatting width of the document.
Scope: View
Syntax
query formwidth
set formwidth LineLength
Options
LineLength |
The maximum displayed length of a line in the Editor. This value must be either 0 or an integer 0 between 20 and 2499 inclusive. The default value for LineLength is 72. |
Description
The formwidth parameter sets the length of the longest line that the formatter displays, when the wrap parameter is on. If wrap is off, long lines are not wrapped.
If the value of the formwidth parameter is 0, the maximum line length is determined by the width of the editing window.
If wrap is off when a document is saved, each element is saved as a single record up to a maximum length of 2499 characters.
The formwidth 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.
| Note: | You must set the formatter parameter to on for the formwidth parameter to have an effect on displayed text. |
Examples
To set the longest line to 500 characters, type:
set formwidth 500
API Return Code
None.
![]()
dispdepth Parameter
formatter Parameter
wrap Parameter
