indent Parameter

Sets the indent factor.

Scope: View

Syntax

query indent 
set indent [Number] 

Option

Number 
The number of character positions used for indentation. The range is integer values between 0 and 5 inclusive; the default value is 2.

Description

The indent parameter specifies the number of character positions by which each level is indented when the document is displayed. The number of indented spaces is the product of the level, which is set by the format parameter in conjunction with the value of Number.

Note: The indent parameter has no effect on displayed text unless the formatter parameter is set to on.

Examples

To set the indent to three character positions, type:

set indent 3 

The actual indent of each element shown in the window varies with the level of the element. For example, an element of level 1 is indented three character positions. A level 2 element is indented six character positions, and a level 0 element has no indent at all.

API Return Code

-2 
The specified Number is not in the valid range of values.

fill Parameter
format Parameter
formatter Parameter