-
Notifications
You must be signed in to change notification settings - Fork 2
/
frame-xgf.html
executable file
·240 lines (233 loc) · 7.79 KB
/
frame-xgf.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
<HTML>
<HEAD>
<!--VA Office of Information and Technology (OIT)-->
<!--Oakland OIFO-->
<!-- START: META DATA -->
<meta http-equiv="Content-Type"
content="text/html; charset=iso-8859-1">
<meta name="language"
content="en">
<meta name="creator"
content="Department of Veterans Affairs (VA), Office of Information and Technology (OIT), VistA Infrastructure (VI)">
<meta name="subject"
content="Kernel APIs: FRAME^XGF">
<meta name="keywords"
content="VistA Infrastructure,VI,Infrastructure,Infrastructure and Security Services,Information Infrastructure Service,OIT,OI&T,ISS,IIS,VISTA,kernel,programmer,developer,programmer manual,apis,application programming interface,application,programming,interface,entry point,FRAME^XGF,FRAME,XGF,xgf function library,supported">
<meta name="description"
content="Kernel APIs: FRAME^XGF">
<meta name="datecreated"
content="20010101">
<meta name="datereviewed"
content="20180813">
<meta name="type"
content="Homepage">
<!-- END: META DATA -->
<title>Kernel APIs: FRAME^XGF</title>
<LINK REL="StyleSheet"
TYPE="text/css"
HREF="common/developer.css">
</HEAD>
<BODY>
<header>
<!--Start Title Banner (image)-->
<TABLE BORDER="0"
WIDTH="100%"
CELLSPACING="3"
CELLPADDING="3"
SUMMARY="This table is for formatting purposes only">
<TR>
<TD VALIGN="top"
ALIGN="left">
<IMG SRC="images/kernel_heading_APIs.gif"
ALT="Kernel 8.0 APIs Banner"
BORDER="0">
<BR>
<IMG SRC="images/oitbanner.gif"
ALT="Office of Information and Technology (OIT) Banner"
BORDER="0">
</TD>
</TR>
</TABLE>
<A HREF="#navskip">
<IMG SRC="images/clr_pxl.gif"
ALT="[skip navigation]"
WIDTH="25"
HEIGHT="1"
BORDER="0"></A>
<!--End Title Banner (image)-->
</header>
<!-- Start Content -->
<H3><A NAME="navskip">FRAME^XGF</A>(): Screen Frame</H3>
<P><B>Reference Type:</B> Supported, <B>Category:</B> XGF Function Library,
<B>ICR#:</B> 3173</P>
<H4><A NAME="description">Description</A></H4>
<P>The FRAME^XGF API draws a box frame on the screen. It displays boxes on the
screen.
<BR>
<BR>
The <strong>FRAME</strong> function does <em>not</em> clear or otherwise change the region
that it encompasses. If you need to open an empty framed window you should use
the <A HREF="win-xgf.html"
CLASS="bodylink"
TITLE="WIN^XGF API">WIN^XGF(): Screen Text Window API</A> instead.
<BR>
<BR>
A call to the
<A HREF="prep-xgf.html"
TITLE="PREP^XGF API"
CLASS="bodylink">PREP^XGF():
Screen/Keyboard Setup API</A> <em>must</em> be made at some point prior to calling
FRAME^XGF.
<BR>
<BR>
Acceptable values for the top and bottom parameters range
from <strong>0</strong> to <strong>IOSL-1</strong>.</P>
<P>Acceptable values for the left and right parameters range
from <strong>0</strong> to <strong>IOM-1</strong>.</P>
<H4><A NAME="format">Format</A></H4>
<PRE> FRAME^XGF(top,left,bottom,right)</PRE>
<H4><A NAME="input_parameters">Input Parameters</A></H4>
<TABLE BORDER="1"
CELLPADDING="5"
BGCOLOR="#F1F2F3"
BORDERCOLORLIGHT="#F1F2F3"
BORDERCOLORDARK="#808080"
WIDTH="100%">
<TR>
<TD VALIGN="TOP"
WIDTH="15%">
<B>top:</B>
</TD>
<TD VALIGN="TOP"
WIDTH="85%">
<P>(required) Top screen coordinate for box.</P>
</TD>
</TR>
<TR>
<TD VALIGN="TOP">
<B>left:</B>
</TD>
<TD VALIGN="TOP">
<P>(required) Left screen coordinate for box.</P>
</TD>
</TR>
<TR>
<TD VALIGN="TOP">
<B>bottom:</B>
</TD>
<TD VALIGN="TOP">
<P>(required) Bottom screen coordinate for box.</P>
</TD>
</TR>
<TR>
<TD VALIGN="TOP"><B>right:</B>
</TD>
<TD VALIGN="TOP">
<P>(required) Right screen coordinate for box.</P>
</TD>
</TR>
</TABLE>
<H4><A NAME="output">Output Parameters</A></H4>
<TABLE BORDER="1"
CELLPADDING="5"
BGCOLOR="#F1F2F3"
BORDERCOLORLIGHT="#F1F2F3"
BORDERCOLORDARK="#808080"
WIDTH="100%">
<TR>
<TD VALIGN="TOP"
WIDTH="15%">
<B>$x and $y:</B>
</TD>
<TD VALIGN="TOP"
WIDTH="85%">
<P>Set to the right and bottom specified as parameters.</P>
</TD>
</TR>
</TABLE>
<P><b>NOTE:</b> See also:
<A HREF="restore-xgf.html"
TITLE="RESTORE^XGF API"
CLASS="bodylink">RESTORE^XGF(): Screen Restore</A> and
<A HREF="win-xgf.html"
TITLE="WIN^XGF API"
CLASS="bodylink">WIN^XGF(): Screen
Text Window API</A> APIs.</P>
<H4><A NAME="example">Example</A></H4>
<P>For example, to draw a box in the center of the screen, do the
following:</P>
<table width="100%"
border="1"
cellspacing="3"
cellpadding="3">
<tr>
<td>
<PRE>><B>D FRAME^XGF(5,20,15,60)</B></PRE>
</td>
</tr>
</table>
<P> </P>
<!-- End Content -->
<footer>
<HR COLOR="003399">
<TABLE WIDTH="100%"
SUMMARY="This table for layout purposes only"
CLASS="white">
<TR>
<TD ALIGN="CENTER"
VALIGN="TOP">
<!--Start Bottom Links-->
<P ALIGN="CENTER">
<A HREF="http://www.va.gov/"
CLASS="bodylink"
TARGET="_top"
TITLE="Department of Veterans Affairs Internet Home Page">
<ACRONYM TITLE="Department of Veterans Affairs">VA</ACRONYM> (Internet)</A> /
<A HREF="http://vaww.va.gov/"
CLASS="bodylink"
TARGET="_top"
TITLE="Department of Veterans Affairs Intranet Home Page">
<ACRONYM TITLE="Department of Veterans Affairs">VA</ACRONYM>(Intranet)</A> /
<A HREF="http://vaww.va.gov/vhaoi/"
CLASS="bodylink"
TARGET="_top"
TITLE="Office of Information Home Page">
<ACRONYM TITLE="Veterans Health Adminstration Office of Health Information (OHI)">VHA OHI</ACRONYM></A> /
<A HREF="https://vaww.oit.va.gov/"
CLASS="bodylink"
TARGET="_top"
TITLE="Office of Information and Technology Home Page">
<ACRONYM TITLE="Office of Information and Technology (OIT)">OIT</ACRONYM></A> /
<A HREF="http://vista.med.va.gov/"
CLASS="bodylink"
TARGET="_top"
TITLE="Product Development (PD) Home Page">
<ACRONYM TITLE="Product Development">PD</ACRONYM></A> /
<A HREF="http://vista.med.va.gov/termsofuse.htm"
CLASS="bodylink"
TARGET="_top"
TITLE="Product Development (PD) Terms of Use Page">Terms of Use</A> /
<A HREF="http://www.va.gov/privacy/"
CLASS="bodylink"
TARGET="_top"
TITLE="Department of Veterans Affairs Privacy Policy">VA Privacy Policy</A> /
<A HREF="http://www1.va.gov/accessible/"
CLASS="bodylink"
TARGET="_top"
TITLE="Department of Veterans Affairs Internet Accessibility">Accessibility</A></P>
<!--End Bottom Links-->
<!--Date content was reviewed or updated-->
<P ALIGN="CENTER">Reviewed/Updated: 08/13/2018
<BR>
<BR>
For questions, comments, or accessibility issues with this website, please contact us by E-Mail:
<A HREF="mailto:VHAISFCVTECH@med.va.gov?subject=Web page comments from: /apis/frame-xgf.html"
TITLE="Send mail to the Webmasters regarding this page"
class="bodylink">Webmasters</A></P>
<P> </P>
</TD>
</TR>
</TABLE>
</footer>
</BODY>
</HTML>