overlay Parameter

Sets text for overlay line.

Scope: View

Syntax

query overlay.RowNumber 
set overlay.RowNumber [TextString] 

Options

RowNumber 
Line where the overlay appears. A positive value is counted from the top of the view; a negative value is counted from the bottom. Because the size of the window can change dynamically, you should use negative values when attempting to set overlays at or near the bottom of the view.
TextString 
Text to appear on the overlay.

Description

The set overlay parameter places a TextString on a specified row in the window. The overlay remains in the fixed position on the window even if the file is scrolled. The string appears in the font set by set font.overlay. An overlay is deleted using set overlay. RowNumber with no text. RowNumber must have the same value and sign used when the overlay was first specified.

Example

  1. To place a warning note on row 3 of the window, type:
    set overlay.3 WARNING: nosave is on 

    The text WARNING: nosave is on stays on row 3 of the window even if the file is scrolled.

  2. To delete the overlay on row 3 of the window, type:
    set overlay.3
  3. To place a warning note on the fourth row from the bottom, type:
    set overlay.-4 WARNING: nosave is on 

API Return Code

-2 
The RowNumber specified was not numeric.

font Parameter