emphasis Parameter

Specifies the current length of the emphasis box.

Scope: Global

Syntax

query emphasis 
set emphasis length 

Option

length 
The length, in characters, of the emphasis box. This value can be any whole number value, including zero.

Description

The emphasis parameter sets an emphasis box around text starting at the current cursor position. The length of the emphasis box is set by the length attribute. Positive values for length will place the emphasis box around text following the cursor, and negative values will place the emphasis box before the cursor. The emphasis box remains displayed until the cursor is moved or the emphasis length is set to 0.

Regardless of length specified, the emphasis box will not wrap onto following or preceding lines of text.

Performing a query on the current emphasis box will return the length of the box in characters.

Examples

  1. To create an emphasis box 4 characters in length, type:
    set emphasis 4 
  2. To find the length of this emphasis box, type:
    query emphasis 

API Return Code

-2 
The value specified for length was outside the valid range.