Function Entry: GRTEXT

← Prev | ↑ Chapter | Next → | Index | Symbols

Function Entry: GRTEXT

Name

grtext

Class

Function

Syntax

(grtext [box text [highlight]])

Arguments and Values

  • box (optional): integer; 0 or greater selects a screen-menu box, -1 selects the mode status line, -2 selects the coordinate status line.
  • text (optional): string to display. Truncated by the device width.
  • highlight (optional): integer; for screen-menu boxes (box >= 0) a positive value highlights and zero unhighlights. Ignored for status-line boxes; coordinate tracking can overwrite the -2 area.

Description

Displays the supplied text in a screen-menu area or the status line; does not change the underlying menu item. With no arguments, restores all text areas to default values. Recognised but no-op on macOS and Web platforms.

Return Values

Returns the text argument when successful, otherwise nil.

Side Effects

Updates the indicated screen-menu / status-line area.

Examples

Not documented on the vendor page.

Availability

  • AutoCAD 2026: documented.
  • BricsCAD V26: presumed compatible.
  • Status: AutoCAD documented; BricsCAD presumed-both pending Phase 4 verification.