Class %ZEN.Component.listControl

deprecatedabstract class %ZEN.Component.listControl extends control

Base class for controls that display a list of values.

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
	9	2

Summary

Properties
%condition	%import	%includeFiles	%page
%resource	align	aux	choiceColumn
clientType	composite	containerStyle	controlClass
controlStyle	dataBinding	disabled	displayList
dragEnabled	dropEnabled	enclosingClass	enclosingStyle
error	height	hidden	hint
hintClass	hintStyle	id	index
invalid	invalidMessage	label	labelClass
labelDisabledClass	labelStyle	maxRows	name
onafterdrag	onbeforedrag	onblur	onchange
onclick	ondblclick	ondrag	ondrop
onfocus	onhide	onkeydown	onkeypress
onkeyup	onmousedown	onmouseout	onmouseover
onmouseup	onrefresh	onshow	onsubmit
ontouchend	ontouchmove	ontouchstart	onupdate
onvalidate	originalValue	parameters	parent
queryClass	queryName	readOnly	required
requiredMessage	showLabel	slice	sql
tabIndex	title	tuple	valign
value	valueColumn	valueList	visible
width	window

Methods
%AddToSaveSet	%Attr	%BindExport	%BuildValueLists
%ClassIsLatestVersion	%ClassName	%ConstructClone	%DispatchClassMethod
%DispatchGetModified	%DispatchGetProperty	%DispatchMethod	%DispatchSetModified
%DispatchSetMultidimProperty	%DispatchSetProperty	%DrawComponentHTML	%DrawHTML
%DrawJSStrings	%EnclosingDivId	%Eval	%EvalC
%Extends	%ForceClientRender	%GetEventHandlers	%GetForm
%GetParameter	%GetXMLName	%IsA	%IsModified
%MakeId	%Name	%New	%NormalizeObject
%ObjectModified	%OnAddToPageAfter	%OnAddToPageBefore	%OnDrawEnclosingDiv
%OnDrawObjectProperties	%OnObjectSynch	%OnZENDeserialize	%OriginalNamespace
%PackageName	%QuoteValue	%QuoteValueL10N	%RemoveFromSaveSet
%Self	%SerializeObject	%SetDefaultValues	%SetModified
%ValidateObject	XMLDTD	XMLExport	XMLExportToStream
XMLExportToString	XMLNew	XMLSchema	XMLSchemaNamespace
XMLSchemaType	dragFinishHandler	dragHandler	dragNotifyHandler
dragStartHandler	dropHandler	dropStartHandler	exposeComponent
findElement	fireOnUpdateEvent	focus	formatValue
getDisabled	getDragData	getEnclosingDiv	getForm
getHidden	getHintElement	getInvalidReason	getLabelElement
getProperty	getReadOnly	getSettings	getType
getValue	invokeSuper	isModified	isOfType
isValid	makeId	normalizeValue	onCreate
onDelete	onDisplayHandler	onEndModalHandler	onPopupAction
onRefreshContents	onSerialize	onStartModalHandler	onchangeHandler
onloadHandler	onunloadHandler	onupdateHandler	refreshContents
render	renderContents	renderSVG	select
setDisabled	setHidden	setOverlayMode	setProperty
setReadOnly	setValue	startProgressBar	stopProgressBar
sysName	unformatValue	validationHandler

Subclasses
%ZEN.Component.multiSelectSet	%ZEN.Component.radioSet	%ZEN.Component.select

Properties

• 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 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 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 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 queryClass as %ZEN.Datatype.className;

(optional) Name of the class containing the query that will provide contents of this table.

• property queryName as %ZEN.Datatype.classMember(MEMBERTYPE="QUERY");

(optional) Name of the class containing the query that will provide contents of this table.

• 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 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 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 "\,".

Methods

• method %BuildValueLists(Output pValueList As %List, Output pDisplayList As %List) as %Status

Called at draw-time to get the ($List) of values and display values.

• method setProperty(property, value, value2) [ Language = javascript ]

Set the value of a named property.

Class Reference IRIS for UNIX 2024.1.2
Documentation Search