...
The Replace field list (replace) parameter is a comma separated list of field descriptions. A field description is a colon separated list of entries that configure the field for display and replacement. Each field has a type and each type has a colon separated list of configuration entries.
If you prefer to see an example before looking at the reference information, go to this example.
The base field configuration that is common to all field types. Position refers to the position within the colon separated list (position1:postion2:position3:position4: etc...). Blanks are valid. Optional fields do not need to be specified.
| Table plus |
|---|
| columnTypes | I |
|---|
| multiple | false |
|---|
| enableSorting | false |
|---|
|
| Position | Entry | Default | Description |
|---|
| 1 | key | required | Field name. It must not be blank or contain blanks. Avoid special characters. This is the name used for replacement in the body. Key is case sensitive. | | 2 | value | blank | Initial field value. Always use the internal value and not the text representation of the value where that is supported. | | 3 | description | key | Prompt text for the field that will appear in the field table. Line breaks with leading space ( <br>) and required spaces ( ) are supported. | | 4 | field type | text | See the field type table for valid values. Invalid types are ignored. |
|
Field Types
...
| multiple | false |
|---|
| enableSorting | false |
|---|
| Type | Description | Addition Positions |
|---|
| text | Text entry box |
| Table plus |
|---|
| columnTypes | I |
|---|
| multiple | false |
|---|
| enableSorting | false |
|---|
|
| Position | Entry | Default | Description |
|---|
| 5 | input size | inputSize parameter | Allows override of global parameter value. |
|
|
|---|
| textarea | Multi-line text area |
| Table plus |
|---|
| columnTypes | I |
|---|
| multiple | false |
|---|
| enableSorting | false |
|---|
|
| Position | Entry | Default | Description |
|---|
| 5 | number of rows | 5 rows |
| | 6 | number of columns | as large as containing area allows |
|
|
|
|---|
radio checkbox | Radio buttons Checkboxes |
| Table plus |
|---|
| columnTypes | I |
|---|
| multiple | false |
|---|
| enableSorting | false |
|---|
|
| Position | Entry | Default | Description |
|---|
| 5 | number of rows | 1 | Layout of the entries. | | 6 | value |
| Value of entry for replacement. | | 7 | text | value | Text for entry for display to user. | | repeat |
|
| Repeated text:value pairs for each entry. |
|
| Tip |
|---|
| An alternative is to use a negative number for position 5 to indicate the number of entries per line. |
|
|---|
select select-multi | Select list Multiple select list |
| Table plus |
|---|
| columnTypes | I |
|---|
| multiple | false |
|---|
| enableSorting | false |
|---|
|
| Position | Entry | Default | Description |
|---|
| 5 | number of rows | 1 | Selections to display. | | 6 | value |
| Value of list entry for replacement | | 7 | text | value | Text for list entry for display to user | | repeat |
|
| Repeated text:value pairs for each list entry |
|
|
|---|
float integer integer-select
| Text entry box with validation Text entry box with validation Select list
|
| Table plus |
|---|
| columnTypes | I |
|---|
| multiple | false |
|---|
| enableSorting | false |
|---|
|
| Position | Entry | Default | Description |
|---|
| 5 | lower bound | no validation | Automatic range validation. Must be valid integer or float value. | | 6 | upper bound | no upper validation |
|
|
| Tip |
|---|
| Bounds are inclusive - greater than or equal and less than or equal. |
| Tip |
|---|
| Both bounds must be specified and the difference must be less than 10000. |
|
|---|
| date | Text entry box with validation |
| Table plus |
|---|
| columnTypes | I |
|---|
| multiple | false |
|---|
| enableSorting | false |
|---|
|
| Position | Entry | Default | Description |
|---|
| 5 | lower bound | no validation | Automatic range validation | | 6 | upper bound | no validation |
| | 7 | date format | dateFormat parameter | Allows override of global parameter value. See Date Format for how to specify this value. |
|
| Tip |
|---|
| Bounds are inclusive - greater than or equal and less than or equal. |
|
|---|
| output | Output text only |
|
|---|
| hidden | Hidden field - does not show in table |
|
|---|
| group | Pseudo field used for grouping of fields |
| Table plus |
|---|
| columnTypes | I |
|---|
| multiple | false |
|---|
| enableSorting | false |
|---|
|
| Position | Entry | Default | Description |
|---|
| 5 | width | as much as needed | Width of the group area in percent (%) or pixels. |
|
|
|---|
| Table plus |
|---|
| multiple | false |
|---|
| enableSorting | false |
|---|
|
|
Field Type Qualifiers
The field type (position 4) entry can be qualified by one or more of the following by appending the qualifier to the field type name.
...