This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > %ZEN.Component.repeatingGroup


class %ZEN.Component.repeatingGroup extends, %ZEN.Component.querySource

A specialized group that repeats its contents based on run-time data.
A repeating group executes a query and, for each row of the results, creates HTML for all of the members of the group. For example:
<repeatingGroup sql="SELECT Name FROM Sample.Person">
<button caption="Press" onclick="alert('#(%query.Name)#');"/>
Each row within the repeating group is referred to as a tuple. For each tuple, the repeating group renders HTML for each of its child components. Note that only one object is created for each child of the repeating group but there are multiple HTML renderings (one per tuple) for each child. The rendered HTML incorporates the current tuple number into the id values used to identify HTML elements to keep track of them.
Applications should keep use of repeatingGroups reasonably simple. Repeating groups within repeating groups are not supported.

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property onclickitem as %ZEN.Datatype.eventHandler;
onclickitem event handler: If defined, this event is fired when the user clicks on an item within the repeating group.
Property methods: onclickitemDisplayToLogical(), onclickitemGet(), onclickitemIsValid(), onclickitemLogicalToDisplay(), onclickitemLogicalToOdbc(), onclickitemNormalize(), onclickitemSet()
property parameters as list of %ZEN.Auxiliary.parameter (XMLNAME = "parameter", XMLPROJECTION = "ELEMENT");
User-defined list of parameters. These values are passed on to the user callback function that provides the query for this table.
Property methods: parametersBuildValueArray(), parametersCollectionToDisplay(), parametersCollectionToOdbc(), parametersDisplayToCollection(), parametersGet(), parametersGetObject(), parametersGetObjectId(), parametersGetSwizzled(), parametersIsValid(), parametersOdbcToCollection(), parametersSet(), parametersSetObject(), parametersSetObjectId()
property selectedIndex as %ZEN.Datatype.integer [ InitialExpression = -1 ];
Indicates which member (0-based) of this repeating group is selected, if any.
Property methods: selectedIndexDisplayToLogical(), selectedIndexGet(), selectedIndexIsValid(), selectedIndexLogicalToDisplay(), selectedIndexLogicalToOdbc(), selectedIndexNormalize(), selectedIndexSet()

Methods (Including Private)

method %DrawHTML()
Draw contents of the group.
clientmethod itemClickHandler(tuple) [ Language = javascript ]
User has clicked on a member of this repeating group. tuple is 0-based.
clientmethod selectItem(tuple) [ Language = javascript ]
Select a member of this repeating group. tuple specifies which member (0-based).
clientmethod setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)