EGL library converseLib
The converseLib system library provides functions related to the EGL converse statement. These functions are shown in the following table.
| Function | Description |
|---|---|
| clearScreen () | Clears the screen, as is useful before the program issues a converse statement in a Text UI program. |
| displayMsgNum (msgNumber) | Retrieves a value from the program's message table. The message is presented the next time that a form is presented by a converse, display, print, or show statement. |
| result = fieldInputLength (textField) | Returns the number of characters that the user typed in the input field when the text form was last presented. That number does not include leading or trailing blanks or nulls. |
| result = getColor (textForm, fieldName) | Returns the current color setting defined for the EGL field name defined on the form. The contents of the field name variable is used to dynamically look up the associated form field variable at execution time. |
| result = getColor (textForm, fieldName, occurrence) | Returns the current color setting defined for the EGL field name defined on the form. The contents of the field name variable and the occurrence integer is used to dynamically look up the associated form field array variable at execution time. |
| result = getCursorColumn () | Returns the number of the column where the cursor is currently positioned. |
| result = getCursorField (textForm) | Returns the EGL variable name of the field in the form that the cursor is currently on. |
| result = getCursorField (textForm, occurrence) | Returns the EGL variable name and occurrence number of the field in the form that the cursor is currently on. An occurrence number of 1 is returned for non-array variables. To find out if the returned variable is an array variable, use the getFormFieldOccurrence function call. |
| result = getCursorLine () | Returns the number of the line where the cursor is currently positioned. |
| result = getFormFieldName (textField) | Returns the EGL field name associated with the form field variable, defined on the form. This is useful when used inside an EGL function with a parameter defined with the "field" parameter option as it allows a program to dynamically determine the field name. |
| result = getFormFieldNameUsingValidationOrder (textForm, orderNumber) | Returns the EGL variable name of the field in the form with the specified validation number. An empty string is returned when the form does not have a field at that validation order number. |
| result = getFormFieldOccurrence (textForm, fieldName) | Returns the number of occurrences that are defined for the EGL field name defined on the form. The contents of the field name variable is used to dynamically look up the associated form field variable at execution time. A value of 1 indicates that the variable is not an array. |
| result = getFormFieldValue (textForm, fieldName) | Returns the current value in the form for the field name defined by the variable fieldName. This function will not return the initial value defined on the text form. The contents of the field name variable is used to dynamically look up the associated form field variable at execution time. |
| result = getFormFieldValue (textForm, fieldName, occurrence) | Returns the current value in the form for the field name defined by the variable fieldName. This function will not return the initial value defined on the text form. The contents of the field name variable and the occurrence integer is used to dynamically look up the associated form field array variable at execution time. |
| result = getHighlight (textForm, fieldName) | Returns the current highlight setting defined for the EGL field name defined on the form. The contents of the field name variable is used to dynamically look up the associated form field variable at execution time. |
| result = getHighlight (textForm, fieldName, occurrence) | Returns the current highlight setting defined for the EGL field name defined on the form. The contents of the field name variable and the occurrence integer is used to dynamically look up the associated form field array variable at execution time. |
| result = getIntensity (textForm, fieldName) | Returns the current intensity setting defined for the EGL field name defined on the form. The contents of the field name variable is used to dynamically look up the associated form field variable at execution time. |
| result = getIntensity (textForm, fieldName, occurrence) | Returns the current intensity setting defined for the EGL field name defined on the form. The contents of the field name variable and the occurrence integer is used to dynamically look up the associated form field array variable at execution time. |
| result = getProtect (textForm, fieldName) | Returns the current protection setting defined for the EGL field name defined on the form. The contents of the field name variable is used to dynamically look up the associated form field variable at execution time. |
| result = getProtect (textForm, fieldName, occurrence) | Returns the current protection setting defined for the EGL field name defined on the form. The contents of the field name variable and the occurrence integer is used to dynamically look up the associated form field array variable at execution time. |
| result = isCursor (textForm, fieldName) | Returns whether the EGL field name defined on the form has the cursor setting on. The contents of the field name variable is used to dynamically look up the associated form field variable at execution time. |
| result = isCursor (textForm, fieldName, occurrence) | Returns whether the EGL field name defined on the form has the cursor setting on. The contents of the field name variable and the occurrence integer is used to dynamically look up the associated form field array variable at execution time. |
| result = isModified (textForm, fieldName) | Returns whether the EGL field name defined on the form has the modified setting on. The contents of the field name variable is used to dynamically look up the associated form field variable at execution time. |
| result = isModified (textForm, fieldName, occurrence) | Returns whether the EGL field name defined on the form has the modified setting on. The contents of the field name variable and the occurrence integer is used to dynamically look up the associated form field array variable at execution time. |
| pageEject () | Advances print-form output to the top of the next page, as is useful before the program issues a print statement. |
| setColor (textForm, fieldName, color) | Set the specified color for the EGL field name defined on the form. The contents of the field name variable is used to dynamically look up the associated form field variable at execution time. |
| setColor (textForm, fieldName, occurrence, color) | Set the specified color for the EGL field name defined on the form. The contents of the field name variable and the occurrence integer is used to dynamically look up the associated form field array variable at execution time. |
| setCursor (textForm, fieldName) | Set the cursor setting on for the EGL field name defined on the form. The contents of the field name variable is used to dynamically look up the associated form field variable at execution time. |
| setCursor (textForm, fieldName, occurrence) | Set the cursor setting on for the EGL field name defined on the form. The contents of the field name variable and the occurrence integer is used to dynamically look up the associated form field array variable at execution time. |
| setCursorPosition (line, column) | Moves the cursor in a Text UI form to a new position. |
| setFormFieldValue (textForm, fieldName, value) | Set the value in the form for the field name defined by the variable fieldName. The contents of the field name variable is used to dynamically look up the associated form field variable at execution time. |
| setFormFieldValue (textForm, fieldName, occurrence, value) | Set the value in the form for the field name defined by the variable fieldName. The contents of the field name variable and the occurrence integer is used to dynamically look up the associated form field array variable at execution time. |
| setHighlight (textForm, fieldName, highlight) | Set the specified highlight for the EGL field name defined on the form. The contents of the field name variable is used to dynamically look up the associated form field variable at execution time. |
| setHighlight (textForm, fieldName, occurrence, highlight) | Set the specified highlight for the EGL field name defined on the form. The contents of the field name variable and the occurrence integer is used to dynamically look up the associated form field array variable at execution time. |
| setIntensity (textForm, fieldName, intensity) | Set the specified intensity for the EGL field name defined on the form. The contents of the field name variable is used to dynamically look up the associated form field variable at execution time. |
| setIntensity (textForm, fieldName, occurrence, intensity) | Set the specified intensity for the EGL field name defined on the form. The contents of the field name variable and the occurrence integer is used to dynamically look up the associated form field array variable at execution time. |
| setModified (textForm, fieldName, modified) | Set the modified setting on for the EGL field name defined on the form. The contents of the field name variable is used to dynamically look up the associated form field variable at execution time. |
| setModified (textForm, fieldName, occurrence, modified) | Set the modified setting on for the EGL field name defined on the form. The contents of the field name variable and the occurrence integer is used to dynamically look up the associated form field array variable at execution time. |
| setProtect (textForm, fieldName, protect) | Set the specified protection for the EGL field name defined on the form. The contents of the field name variable is used to dynamically look up the associated form field variable at execution time. |
| setProtect (textForm, fieldName, occurrence, protect) | Set the specified protection for the EGL field name defined on the form. The contents of the field name variable and the occurrence integer is used to dynamically look up the associated form field array variable at execution time. |
| validationFailed (msgNumber) |
|