ruler Parameter

Controls the display of a ruler at the top of the Editor.

Scope: View

Syntax

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

Options

on 
Displays the ruler at the top of the current Editor.
off 
Removes the ruler from the top of the Editor, if any. This is the initial display mode.
inverse 
Toggles between on and off.
default
Ruler display is controlled by the value of the default parameter.

Description

The ruler parameter controls the display of a ruler in an edit view. The content of the ruler is specified with the rulertext parameter. The scrolling and highlighting of the cursor location are handled by the Editor. The ruler does not wrap when wrap is set on.

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

Examples

  1. To display a ruler at the top of the current Editor, type:
    set ruler on 
  2. To control ruler display with the value defined by the default parameter, type:
    set ruler default 
  3. To display the value of the ruler parameter, type:
    query ruler 

    If this query returns DEFAULT, type the following:

    query default.ruler

API Return Codes

-2 The option you specified was not on, off, or inverse. Issue the set command again using one of these options.

default parameter
rulertext Parameter