overhang Parameter

Specifies overhang for flowed lines.

Scope: View

Syntax

query overhang 
set overhang [Number] 

Option

Number 
The value, positive or negative, by which indent is multiplied to determine direction (right or left) and the number of characters to indent lines. The default value is 1.

Description

The value of the overhang parameter determines the indentation of flowed lines in a paragraph of text. A paragraph is any length of text ended by a hard carriage return.

A paragraph can be wrapped (flowed) over multiple lines. The overhang parameter sets the indentation of the second and subsequent lines of a paragraph.

Multiply the values of the overhang and indent parameters together to calculate the offset for the start columns of flowed lines. This offset is measured in character positions from the start column of first line in the paragraph. A positive offset value starts flowed lines to the right of the start column of the first line. A negative offset value starts flowed lines to the left of the start column of the first line. The overhang parameter has no effect on the start column of the first line in a paragraph.

Notes:

  1. You must set the formatter parameter to on for the overhang parameter to have an effect on displayed text.
  2. The Editor will accept, but not use, indent or overhang parameter values that cause less than 14 characters to be displayed on a wrapped line.

Examples

For the following examples, place the cursor on the first line of a paragraph before typing the following commands in the Issue edit command window.

  1. Set an initial formatting style for the document by typing these Editor commands:
    set formatter on 
    set wrap on 
    set formwidth 60 
    set format absolute 4 
  2. If the indent parameter is set to 2, then to set an indentation of 6 characters to the right of the first element, type this Editor command:
    set overhang 3 

    The second and subsequent lines are indented 4 characters to the right as shown below:

         Rather than holding data passively while it is 
               being edited, the Editor recognizes the 
               different elements of a program or document.
  3. If the indent parameter is set to 2, then to set an indentation of 6 characters to the left of the first element, type:
    set overhang -3

    The second and subsequent lines are indented 4 characters to the left as shown below:

             Rather than holding data passively while it is 
         being edited, the Editor recognizes the different 
         elements of a program or document.

API Return Codes

-2 
The number specified was either outside the valid range or not a whole number. Issue the command again using a valid number.

flow Parameter
format Parameter
indent Parameter
wrap Parameter