GML Attribute and Cell Data (Text) Template - GML_TPL$
The GML_TPL$ template contains the parameters necessary for interfacing with grid controls. When a GML procedure is executed, the fields within the template contain the values that are appropriate for the task being performed. Not all fields within the template are used for each procedure. The variables contained in the template are described in the following groups:
Variables Referencing Grid Set, Row, and Column Locations
GML_TPL.SET% |
A grid set the procedure is related to, with a value of one to the maximum grid sets being managed by the GML. |
GML_TPL.MEMBER% |
The specific grid control within the grid set. A value of one indicates a main grid control, value of two indicates a column heading grid control, and a value of three indicates a row heading grid control. |
GML_TPL.ROW_N% |
A row number in the range of one to the maximum rows in the grid. |
GML_TPL.COL_N% |
A column number in the range of one to the maximum columns in the grid. |
A GML_TPL.ROW_N% or GML_TPL.COL_N% value of less then one has a special meaning explained in the GML UPDATE procedure section of this document.
Variables Containing Grid Data (Text)
GML_TPL.COL$[c] |
Grid cell text with the value of [c] indicating the column number. The column number ranges from one to the maximum columns in the grid. |
GML_TPL.REL$[c] |
Text that is related to the grid cell text. As an example, a grid cell containing an account number might use the GML_TPL.REL$[c] location to store the actual file key in the GML variables. |
Variables Affecting the Attributes of each Grid Cell
GML_TPL.T_COLOR$[c] |
[c] column text color. |
GML_TPL.B_COLOR$[c] |
[c] column background color. |
GML_TPL.STYLE%[c] |
[c] column grid cell style (INPUTE, raised button, etc). |
GML_TPL.ALIGN%[c] |
[c] column cell alignment (left, centered, right). |
GML_TPL.IMAGE%[c] |
[c] column index # of an image displayed within a cell. |
GML_TPL.DEFAULT$[c] |
[c] column default attributes. |
Variables Affecting Grid Cell Editing
GML_TPL.E_MODE%[c] |
allows or restricts editing of a main grid cell. |
GML_TPL.MASK$[c] |
relates to a mask for the [c] column. |
Miscellaneous Use Variables
GML_TPL.OPTION% |
The use of a particular option for a specific procedure. |
ML_TPL.DEF_FLAG% |
The use of a particular feature for a specific procedure. |
GML_TPL.FLAG% |
A value relating to the execution of a procedure. |
GML_TPL.TEXT$ |
Text used for multiple purposes. |
GML_TPL.ARG% |
Numeric variable used with certain procedures. |
GML_TPL.SUP% |
Numeric variable used with certain procedures. |
GML_TPL.INFO$ |
Information relating to certain procedures. |
GML_TPL.ROW_STAT% |
Row status information. |
GML_TPL$: Template Initialization
Each time the GML_TPL$ template is used it must be initialized. This initialization prepares the template for use by matching the template parameters to the specific grid set it will interface. The initialization also sets variables to pre-set values which are necessary for the correct completion of a procedure by the GML. The procedure used for this initialization is outlined in the GML Procedure section of this document.