Primitive field-level properties

The next table lists the primitive field-level properties in EGL.

property Description
@linkParameter (as described in @programLinkData) Identifies the value to be placed in a particular input-record field of a receiving program when the user at a Web browser transfers control from one program of type VGWebTransaction to another.
@linkParms (as described in @programLinkData) Identifies the values to be placed in an input record when the user at a Web browser transfers control from one program of type VGWebTransaction to another.
@programLinkData Specifies details for transferring control from one program of type VGWebTransaction to another when the user at a Web browser submits a form or clicks a hypertext link.
@xsd Provides a mapping of data types for use when EGL code interacts with a Web service:
  • In relation to an EGL Web service, establishes a set of validation rules that limit the kind of data that will be provided to the service at run time
  • In relation to an interface that provides access to a Web service, ensures a valid mapping between an EGL data type and the type of data submitted to or received from the service
action Identifies the code that is invoked when the user clicks the button or link.
alias Is used in a program of type VGWebTransaction to relate a VGUI field and a JSP control ID. The property is useful in this case:
  • You migrated a program from VisualAge® Generator; and
  • The ID in the existing JSP is not valid in EGL.
align Specifies the position of data in a variable field when the length of the data is smaller than the length of the field.
byPassValidation Indicates whether EGL-based validation is bypassed when the user clicks the button or link.
color Specifies the color of a field in a text form.
column Refers to the name of the database table column that is associated with the field. The default is the name of the field.
currency Indicates whether to include a currency symbol before the value in a numeric field, with the exact position of the symbol determined by the zeroFormat property.
currencySymbol Indicates which currency symbol to use when the property currency is in effect.
dateFormat Identifies the format for dates.
  Specifies whether the field's modified data tag is set when the field is selected by a light pen or (for emulator sessions) by a cursor click.
displayName Specifies the label that is displayed next to the control on a Web page.
displayNames Specifies an array of labels, each of which is displayed next to the equivalent control in an array of controls. This property is used only in a program of type VGWebTransaction.
displayUse Associates an EGL field with a user-interface control.
dliFieldName Refers to the name of the DL/I database segment field that is associated with the field in the EGL record of type DLISegment. The default is the name of the EGL record field.
fieldLen Specifies the number of single-byte characters that can be displayed in a text-form field.
fill Indicates whether the user is required to enter data in each field position.
fillCharacter Indicates what character fills unused positions in a text or print form or in PageHandler data.
help Specifies the hover-help text that is displayed when the user places the cursor over the input field.
highlight Specifies the special effect (if any) with which to display the field.
inputRequired Indicates whether the user is required to place data in the field.
inputRequiredMsgKey Identifies the message that is displayed if the field property inputRequired is set to yes and the user fails to place data into the field.
intensity Specifies the strength of the displayed font.
isBoolean Indicates that the field represents a Boolean value.
isDecimalDigit Determines whether to check that the input value includes only decimal digits
isHexDigit Determines whether to check that the input value includes only hexadecimal digits
isNullable Indicates whether the field can be set to null, as is appropriate if the table column associated with the field can be set to NULL.
isReadOnly Indicates whether the field and related column should be omitted from the default SQL statements that write to the database or include a FOR UPDATE OF clause.
lineWrap Indicates whether text can be wrapped onto a new line whenever wrapping is necessary to avoid truncating text.
lowerCase Indicates whether to set alphabetic characters to lower case in the user's single-byte character input.
masked Indicates whether a user-entered character will or will not be displayed.
maxLen Specifies the maximum length of field text that is written to the database column.
minimumInput Indicates the minimum number of characters that the user is required to place in the field, if the user places any data in the field.
minimumInputMsgKey Identifies the message that is displayed if the user acts as follows:
  • Places data in the field; and
  • Places fewer characters than the value specified in the property minimumInputRequired.
modified Indicates whether the program will consider the field to have been modified, regardless of whether the user changed the value.
needsSOSI Indicates whether EGL does a special check when the user enters data of type MBCHAR on an ASCII device.
newWindow Indicates whether to use a new browser window when the EGL runtime presents a Web page in response to the activity identified in the action property.
numElementsItem Identifies a PageHandler field whose runtime value specifies the number of array elements to display.
numericFormat Specifies the format of a numeric field in a Web page displayed by a program of type VGWebTransaction.
numericSeparator Indicates whether to place a character in a number that has an integer component of more than 3 digits.
outline Lets you draw lines at the edges of fields on any device that supports double-byte characters.
pattern Matches the user entered text against a specified pattern, for validation.
persistent Indicates whether the field is included in the implicit SQL statements generated for the SQL record.
protect Specifies whether the user can access the field.
runValidatorFromProgram Is used in a program of type VGWebTransaction to indicate whether the validator function runs on the Web application server (in the UI record bean) or runs in the program that receives data from the user.
selectedIndexItem Is used for a VGUI-field array and refers to the selected index item, which is a VGUI field whose value indicates two aspects of runtime processing: whether a control (such as a check box) is pre-selected when the Web page is displayed; and whether the user selected a control.
selectFromListItem Identifies the array or DataTable column from which the user selects a value or values, which are then transferred to the array or primitive field being declared.
selectType Indicates the kind of value that is retrieved into the array or primitive field being declared.
sign Indicates the position in which a positive (+) or negative (-) sign is displayed when a number is placed in the field, whether from user input or from the program.
sqlDataCode Identifies the SQL data type that is associated with the record field.
sqlVariableLen Indicates whether trailing blanks and nulls in a character field are truncated before the EGL runtime writes the data to an SQL database.
timeFormat Identifies the format for times.
timestampFormat Identifies the format for timestamps that are displayed on a form or maintained in a PageHandler.
typeChkMsgKey Identifies the message that is displayed if the input data is not appropriate for the field type.
uiType Specifies the HTML tags to be created when a program of type VGWebTransaction issues a show or converse statement that displays a record of type VGUIRecord.
upperCase Indicates whether to set alphabetic characters to upper case in the user's single-byte character input.
validationOrder Indicates when the field's validator function runs in relation to any other field's validator function.
validatorDataTable Identifies a validator table, which is a dataTable part that acts as the basis of a comparison with user input.
validatorDataTableMsgKey Identifies the message that is displayed if the user provides data that does not correspond to the requirements of the validator table, which is the table specified in the property validatorDataTable.
validatorFunction Identifies a validator function, which is logic that runs after the EGL runtime does the elementary validation checks, if any.
validatorFunctionMsgKey Identifies a message that is displayed if the validator function indicates an error.
validValues Indicates a set of values that are valid for user input.
validValuesMsgKey Identifies the message that is displayed if the field property validValues is set and the user places out-of-range data into the field.
value Identifies a string literal that is displayed as the field content when a Web page is displayed.
zeroFormat Specifies how zero values are displayed in numeric fields but not in fields of type MONEY.
Feedback
(C) Copyright IBM Corporation 2000, 2005. All Rights Reserved.