SubGroup element attributes
- Last UpdatedApr 24, 2025
- 2 minute read
The SubGroup element is used to create a group inside a tab on the form. A group is a collection of related columns.
Note: All attributes are required unless indicated as optional.
The attributes of the SubGroup element of a form are as follows:
-
Optional: ArrayDimension is the number of elements in the array if IsArray is set to true.
-
Optional: ArrayStartIndex is the index for the starting array if the IsArray is set to true.
-
IsArray is set to true if the fields shown in the group are an array.
Note: When the IsArray attribute is set to true, the value of the Name attribute must be a valid field specifier prefix. In addition, the nested field names must exclude the name of the SubGroup attribute.
For example, in the remote schedule entry array, the field sched[#].priority has the Name field of the SubGroup attribute set to sched and the nested Name field of the Field element set to priority. If the array is a simple array rather than an array of structures (for example, values[#]), the Name field of the SubGroup attribute is set to the array name (that is, values) and the nested Name field of the Field element is set to "". -
Label is the name of the SubGroup element shown as the group text.
-
Name is the name of the SubGroup element.
-
Optional: RowsToDisplay is used to indicate the number of rows to display at a time. The number of rows added to the edit form comes from the range running from ArrayStartIndex to ArrayDimension. An Administrator will need to scroll to view the rows beyond the number indicated in the RowsToDisplay attribute. To avoid displaying rows at the end of the array, specify an ArrayDimension value that is smaller than the actual size of the array.
-
Optional: ToolTipText is the description of the SubGroup element that appears when you hover the mouse pointer over the element.