VGUIRecord part in EGL source format

An example of a VGUIRecord part is as follows:
    Record  MyUIRecord  Type  VGUIRecord 
    { commandValueItem=”buttonValue” }
	     10 formItem  char(20)
	     { uiType=uiForm, 
        @programLinkData { programName=”NewPgm”,
                           newWindow=yes,
			  uiRecordName=”NewUIR”,
			linkParms = [
			   @LinkParameter { name=”key1”,
						value=”value1” },
			   @LinkParameter { name = “key2”,
						valueRef=”refItem” }
			]
        }
	   };
The syntax diagram for a VGUIRecord part is as follows:

Syntax diagram for a VGUIRecord part
Record recordPartName VGUIRecord ... end
Identifies the part as being of type VGUIRecord and specifies the part name. For the rules of naming, see Naming conventions.
alias = "alias"
A string that is incorporated into the names of generated output. If you do not set the alias property, the part name is used instead.
commandValueItem = "VGUIRecordFieldName"
Name of the VGUI record field that contains the value of the SUBMIT button or hypertext link clicked by the user. The field must be of a character type, as described in Primitive types.
Regardless of whether you specify a value for the property commandValueItem, the following is true:
  • If the user clicks a SUBMIT button that has a valid ConverseVar.eventKey value ("PF1" - "PF24", "PA1" - "PA3", or "ENTER"), the value is placed in ConverseVar.eventKey
  • If the user clicks a SUBMIT button that has a value other than a valid ConverseVar.eventKey value, the value "ENTER" is placed in ConverseVar.eventKey
  • You can test the value of ConverseVar.eventKey in your code
help = "helpText"
A string that is available at runtime, but you must tailor the VGUI record JSP file to access that text from the VGUI record bean. You may want to include a client-side script in the VGUI record JSP so the user can easily access the help text.
runValidatorFromProgram = yes, runValidatorFromProgram=no
Concerns the validator function, which is the function referenced in the validatorFunction property.

If the property runValidatorFromProgram is set to yes (the default), the validator function runs in the EGL program that gets control after a converse or show statement is processed. Otherwise,, the validator function runs on the Web application server.

Accept the default setting if validation requires access to program variables or to other resources that are not available in the Web application server.

title =" defaultTitle"
Refers to the title that is associated with the VGUI record on the Web page. You specify the title by specifying a quoted string in place of title; then, by default, the title is shown in an HTML <H1> tag that precedes the VGUI record. You can override and reformat the title when you customize the JSP file in PageDesigner.
validatorFunction = "functionPartName"
The name of the validator function, which validates input data after field-specific validation is complete.
structureField
A structure field, as described in Structure field in EGL source format. When defining that structure, consider (especially) the following primitive field-level properties:
  • @programLinkData
  • alias
  • displayName
  • help
  • numElementsItem
  • selectedIndexItem
  • uiType

For details, see Primitive field-level properties.

Feedback
(C) Copyright IBM Corporation 2000, 2005. All Rights Reserved.