Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / %DeepSee.Component.controlDefinition
Private  Storage   

%DeepSee.Component.controlDefinition


class %DeepSee.Component.controlDefinition extends
%ZEN.Component.object

Defines a control definition within a Dashboard widget definition. This is used by the Widget editor. It is not the saved state of the control.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 17


Summary


Properties
%condition %import %includeFiles %page %resource
action activeWhen aux composite controlClass
displayList id index label location
name onupdate parent readOnly size
target targetProperty text timeout title
tuple type value valueList valueRequired
visible window

Methods
%AddToSaveSet %Attr %BindExport %ClassIsLatestVersion
%ClassName %ConstructClone %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %DrawHTML %DrawJSStrings %Eval
%EvalC %Extends %ForceClientRender %GetEventHandlers
%GetParameter %GetXMLName %IsA %IsModified
%MakeId %New %NormalizeObject %ObjectModified
%OnAddToPageAfter %OnAddToPageBefore %OnDrawObjectProperties %OnObjectSynch
%OnZENDeserialize %OriginalNamespace %PackageName %QuoteValue
%QuoteValueL10N %RemoveFromSaveSet %Self %SerializeObject
%SetModified %ValidateObject XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType findElement fireOnUpdateEvent
getProperty getSettings getType invokeSuper
isOfType makeId onCreate onDelete
onSerialize onloadHandler onunloadHandler onupdateHandler
render renderContents renderSVG setProperty


Parameters


• parameter NAMESPACE = "http://www.intersystems.com/deepsee";
This is the XML namespace used for library components.

Properties


• property action as %String(MAXLEN=50);
What action to take when this control is activated.
• property activeWhen as %String(MAXLEN=255,XMLPROJECTION="attribute");
Specifies when this control is enabled.
• property controlClass as %String(MAXLEN=255,XMLPROJECTION="attribute");
Class name of component to user for this control when type is "custom".
• property displayList as %String(MAXLEN=255,XMLPROJECTION="attribute");
Comma-delimited list of display values for the filter. If supplied this overrides a default list.
• property label as %String(MAXLEN=255,XMLPROJECTION="attribute");
Label to display for the control.
• property location as %String(MAXLEN=50,VALUELIST=",widget,dashboard",XMLPROJECTION="attribute") [ InitialExpression = "widget" ];
Specifies where to place the control.
• property readOnly as %Boolean(XMLPROJECTION="attribute");
Is control read only?
• property size as %Integer(MINVAL=0,XMLPROJECTION="attribute");
Size to apply to control.
• property target as %String(MAXLEN=250,XMLPROJECTION="attribute");
Comma-delimited list of names of widgets to apply action to.
• property targetProperty as %String(MAXLEN=500,XMLPROJECTION="attribute");
Actual specification of property within widget to apply the action to.
• property text as %String(MAXLEN=255,XMLPROJECTION="attribute");
Default text value for the control.
• property timeout as %String(XMLPROJECTION="attribute");
Timeout for this control when type is "timer".
• property title as %String(MAXLEN=255,XMLPROJECTION="attribute");
Title to display for the control.
• property type as %String(MAXLEN=255,XMLPROJECTION="attribute");
General type of control to use.
• property value as %String(MAXLEN=255,XMLPROJECTION="attribute");
Default value for the control.
• property valueList as %String(MAXLEN=255,XMLPROJECTION="attribute");
Comma-delimited list of permitted values for the control. If supplied this overrides a default list.
• property valueRequired as %Boolean [ InitialExpression = 0 ];
If set to true, the control must be assigned a value.