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

%ZEN.Component.listControl

abstract class %ZEN.Component.listControl extends %ZEN.Component.control

Base class for controls that display a list of values.

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property choiceColumn as %ZEN.Datatype.integer (MINVAL = 1, ZENSETTING = 0) [ InitialExpression = 2 ];
(optional) If there are multiple data columns returned by the class query this is the column number (1-based) of the column that will provide the display value for this control.
If this value is greater than the number of columns in the query or unspecified then the second column will be used.
This property is only used if queryClass and queryName are specified.
Property methods: choiceColumnDisplayToLogical(), choiceColumnGet(), choiceColumnIsValid(), choiceColumnLogicalToDisplay(), choiceColumnLogicalToOdbc(), choiceColumnNormalize(), choiceColumnSet()
property displayList as %ZEN.Datatype.csv (ZENLOCALIZE = 1);
(optional) Defines set of displayed choices for this select control as a csv-list.
The entire list is a localized value.
If your data include commas, escape them with "\,".
Property methods: displayListDisplayToLogical(), displayListGet(), displayListIsValid(), displayListLogicalToDisplay(), displayListLogicalToOdbc(), displayListNormalize(), displayListSet()
property maxRows as %ZEN.Datatype.integer [ InitialExpression = 500 ];
If a query is used to provide data, this is the maximum number of items that will be displayed.
Property methods: maxRowsDisplayToLogical(), maxRowsGet(), maxRowsIsValid(), maxRowsLogicalToDisplay(), maxRowsLogicalToOdbc(), maxRowsNormalize(), maxRowsSet()
property parameters as list of %ZEN.Auxiliary.parameter (XMLNAME = "parameter", XMLPROJECTION = "ELEMENT");
User-defined list of query parameters.
If this control uses a query, these values are used to provide values for any run-time query parameters.
Property methods: parametersBuildValueArray(), parametersCollectionToDisplay(), parametersCollectionToOdbc(), parametersDisplayToCollection(), parametersGet(), parametersGetObject(), parametersGetObjectId(), parametersGetSwizzled(), parametersIsValid(), parametersOdbcToCollection(), parametersSet(), parametersSetObject(), parametersSetObjectId()
property queryClass as %ZEN.Datatype.className;
(optional) Name of the class containing the query that will provide contents of this table.
Property methods: queryClassDisplayToLogical(), queryClassGet(), queryClassIsValid(), queryClassLogicalToDisplay(), queryClassLogicalToOdbc(), queryClassNormalize(), queryClassSet()
property queryName as %ZEN.Datatype.classMember (MEMBERTYPE = "QUERY");
(optional) Name of the class containing the query that will provide contents of this table.
Property methods: queryNameDisplayToLogical(), queryNameGet(), queryNameIsValid(), queryNameLogicalToDisplay(), queryNameLogicalToOdbc(), queryNameNormalize(), queryNameSet()
property sql as %ZEN.Datatype.sql;
(optional) SQL SELECT statement that, if present, provides values for the select list. The first column of the results provides the value, and the second column, if present, provides the display value.
If defined, this takes precedence over queryClass and queryName.
Property methods: sqlDisplayToLogical(), sqlGet(), sqlIsValid(), sqlLogicalToDisplay(), sqlLogicalToOdbc(), sqlNormalize(), sqlSet()
property valueColumn as %ZEN.Datatype.integer (MINVAL = 1, ZENSETTING = 0) [ InitialExpression = 1 ];
(optional) If there are multiple data columns returned by the class query this is the column number (1-based) of the column that will provide the logical value for this control.
If this value is greater than the number of columns in the query or unspecified then the first column will be used.
This property is only used if queryClass and queryName are specified.
Property methods: valueColumnDisplayToLogical(), valueColumnGet(), valueColumnIsValid(), valueColumnLogicalToDisplay(), valueColumnLogicalToOdbc(), valueColumnNormalize(), valueColumnSet()
property valueList as %ZEN.Datatype.csv;
Defines set of values for choices for this select control as a csv-list.
If your data include commas, escape them with "\,".
Property methods: valueListDisplayToLogical(), valueListGet(), valueListIsValid(), valueListLogicalToDisplay(), valueListLogicalToOdbc(), valueListNormalize(), valueListSet()

Methods (Including Private)

method %BuildValueLists(Output pValueList As %List, Output pDisplayList As %List) as %Status [ Language = objectscript ]
Called at draw-time to get the ($List) of values and display values.
clientmethod setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Subclasses