|
![[skip navigation]](images/clr_pxl.gif){kind=small}
|
|
Reference Type: Supported, Category: XGF Function Library, ICR#: 3173
The FRAME^XGF API draws a box frame on the screen. It displays boxes on the
screen.
The FRAME function does not clear or otherwise change the region
that it encompasses. If you need to open an empty framed window you should use
the WIN^XGF(): Screen Text Window API instead.
A call to the
PREP^XGF():
Screen/Keyboard Setup API must be made at some point prior to calling
FRAME^XGF.
Acceptable values for the top and bottom parameters range
from 0 to IOSL-1.
Acceptable values for the left and right parameters range from 0 to IOM-1.
FRAME^XGF(top,left,bottom,right)
| top: |
(required) Top screen coordinate for box. |
| left: |
(required) Left screen coordinate for box. |
| bottom: |
(required) Bottom screen coordinate for box. |
| right: |
(required) Right screen coordinate for box. |
| $x and $y: |
Set to the right and bottom specified as parameters. |
NOTE: See also: RESTORE^XGF(): Screen Restore and WIN^XGF(): Screen Text Window API APIs.
For example, to draw a box in the center of the screen, do the following:
>D FRAME^XGF(5,20,15,60) |