Class %ZEN.Component.label

deprecatedclass %ZEN.Component.label extends control

Simple label control. A label passively displays a static text value. The value of the label is submitted along with other controls on a form.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
1		5

Summary

Properties
%condition	%import	%includeFiles	%page
%resource	align	aux	clientType
composite	containerStyle	controlClass	controlStyle
dataBinding	disabled	dragEnabled	dropEnabled
enclosingClass	enclosingStyle	error	height
hidden	hint	hintClass	hintStyle
id	index	invalid	invalidMessage
label	labelClass	labelDisabledClass	labelStyle
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	parent
readOnly	required	requiredMessage	showLabel
slice	tabIndex	title	tuple
valign	value	visible	width
window

Methods
%AddToSaveSet	%Attr	%BindExport	%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

Parameters

• parameter DEFAULTCONTROLCLASS = "labelText";

The default css class used for the main element within this control. This is overridden by subclasses.

Methods

• method %DrawHTML()

Static HTML display method: draw the BODY of this component as HTML.
Subclasses implement this in order to render the static HTML contents of a component.

• method %SetDefaultValues()

This method fills in reasonable default values for this control. Used by tools (such as Control Tester) to dynamically create controls.

• method getProperty(property, key) as %String [ Language = javascript ]

Override to get current value of control.

• method onSerialize() [ Language = javascript ]

This is called when the client serializes this object.
This gives us a chance to make sure that the value property is updated to have the current value displayed within the control. This version will take care of this for native controls. Custom controls must either ensure that the value property matches the current value of the control or override this method.

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

Set the value of a named property.


[USER] > [%ZEN] > [Component] > [label]		Private Storage