The uiType property
specifies the HTML tags to
be created when a VGWebTransaction program issues a show or converse statement
that displays a VGUIRecord.
Valid values come from the
UITypeKind enumeration:
- hidden
- Causes the record
field to be translated to one or more HTML <input>
tags with the "type=hidden" attribute. The value that you assign programmatically
to a record field in this case is available to any program invoked
from the
web page, but is visible to the user only if the user reviews the
web-page
source by way of browser-specific keystrokes. If you want to prevent
the user
from seeing a value, use the none value
rather than
the hidden value.
- input
- Causes the record field to be translated to an HTML tag or tags
that allow
the user to assign values. The type of HTML tags that EGL generates
depends
on other declaration-time settings.
- EGL edits input values
for this uiType. Although the translated tags can
display values assigned programmatically, EGL does not format the
output for
those values.
- inputOutput
- Causes the record field to be translated to an HTML tag or tags
with initial
display values that the user can change. The type of HTML tags that
EGL generates
depends on other declaration-time settings.
- EGL formats output
and edits input for values with this uiType.
- none
- Causes the record field to be excluded from the HTML sent to the
browser.
In most cases, the field is available on tiers 2 and 3.
You can
use the
record field in an edit function that runs on tier 2, but only if
the VGUI
record is presented either by a converse statement or by a show statement
with a returning to clause.
If a VGUI record is presented
by
a show statement without a returning to clause, you
cannot store
the record field on tier 2 for use after the user submits the page,
because
after the user submits the page, the UI record bean and UI record
object are
created with data from the browser and only from the browser.
If
you
use a record field for which the uiType is none as
a link parameter in a field for which the uiType is submit, submitBypass,
or programLink, EGL runtime treats a uiType of none as
uiType hidden and includes the generated field in the HTML.
- output
- Causes
the value of the record field to be placed in the HTML. Some aspects
of the HTML output vary according to other declaration-time settings.
The
user cannot type data to change an output value on the web page but
in some
cases can select one or more output values from a list, in which case
the
selections are made available to the program.
EGL runtime performs
output formatting on fields for which the uiType is output.
- programLink
- Causes
the record field to be translated to an HTML <A> tag, which
is displayed as a hypertext link. You use the property @programLinkData to
specify a VGWebTransaction program that will be invoked if the user
clicks
the hypertext link.
- submit
- Causes the record field to be translated to a SUBMIT type HTML
tag. If
the user clicks the SUBMIT button that results from that tag, EGL
runtime
on tier 2 performs edits on the user's input and (if the edits succeed)
sends
the user data (including the SUBMIT button value) to the program on
tier 3.
The button value is stored in the submit value field.
- submitBypass
- Causes
the record field to be translated to an HTML <INPUT> tag of
type SUBMIT. If the user clicks the SUBMIT button that results from
that tag,
the button value is stored in the submit value field and is made available
to the program on tier 3. The rest of the user's input is ignored.
The
primary
use of a field for which uiType is submitBypass is to define an Exit
button.
- uiForm
- Causes the record field to be translated to an HTML <FORM>
structure,
which is separate from the default HTML <FORM> structure that is
provided
when the web transaction presents a web page.
You use the property @programLinkData to
specify a VGWebTransaction program that will be invoked if the user
clicks
a SUBMIT button from within the derived <FORM> structure. The data
submitted
to that program can include data from the user as well as data received
from
the program that presented the web page.