IOXY^XGF(): Screen Cursor Placement

Reference Type: Supported, Category: XGF Function Library, ICR#: 3173

Description

The IOXY^XGF API positions the cursor on the screen at a screen coordinate. This API is similar to Kernel's X IOXY function:

• The row parameter must be between 0 and IOSL-1.
  
  
• The column parameter must be between 0 and IOM- 1.

A call to the PREP^XGF(): Screen/Keyboard Setup API must be made at some point prior to calling IOXY^XGF.

You can specify row and column parameters relative to the current $X and $Y by specifying + or - to increment or decrement $X or $Y by 1. You can increment or decrement by more than one if you add a number as well, such as "-5" or "+10".

NOTE: You must use quotes to pass a "+" or "-". Otherwise, to specify exact locations for row and column, pass numbers.

Format

  IOXY^XGF(row,col)

Input Parameters

Output Variables

NOTE: See also: SAY^XGF():Screen String and SAYU^XGF(): Screen String with Attributes APIs.

Example

For example, to position the cursor at row 12, column 39, do the following:

>D IOXY^XGF(12,39)