Home > Class Reference > ENSLIB namespace > %DeepSee.Dashboard.Control


serial class %DeepSee.Dashboard.Control extends %SerialObject, %XML.Adaptor

This class defines a control within a user-defined DeepSee dashboard widget. Controls are used to vary the values of data source parameters (such as changing the time period to display).


Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 23 1


action actionDisplay activeWhen activeWhenDisplay
controlClass displayList label location
locationDisplay name readOnly size
target targetProperty targetPropertyDisplay text
timeout title type typeDisplay
value valueList valueRequired
%AddToSaveSet %AddToSyncSet %ClassIsLatestVersion %ClassName
%ConstructClone %CopyTo %Delete %DeleteId
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %GetSwizzleObject %IsA %IsModified
%IsNull %New %NormalizeObject %ObjectIsNull
%ObjectModified %OnBeforeAddToSync %OnDetermineClass %Open
%OpenId %OriginalNamespace %PackageName %RemoveFromSaveSet
%ResolveConcurrencyConflict %SerializeObject %SetModified %SyncObjectIn
%SyncTransport %ValidateObject LogicalToOdbc OdbcToLogical
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType


parameter NAMESPACE = "http://www.intersystems.com/deepsee/library";
NAMESPACE specifies the XML namespace to be used when projecting the class to XML. If NAMESPACE = "", the default namespace is used for the XML schema is used as the namespace for his class.
parameter XMLIGNORENULL = 1;
XMLIGNORENULL allows the programmer to override the default XML handling of empty strings for properties of type %String. By default (XMLIGNORENULL = 0), empty strings in the XML input are stored as $c(0) and $c(0) is written to XML as an empty tag. A missing tag in the XML input is always stored as "" and "" is always output to XML as no tag.

If XMLIGNORENULL is set = 1, then both missing tags in the XML and empty strings are input as "", and both "" and $c(0) are output as empty tags (i.e. <tag></tag>).

If XMLIGNORENULL is set = "inputonly", then both missing tags in the XML and empty strings are input as "". Output of "" and $c(0) are for XMLIGNORENULL = 0: $c(0) is output as an empty tag (i.e. <tag></tag>) and "" is output as no tag.

If XMLIGNORENULL = "runtime" (runtime is not case sensitive), then the behavior of XMLIGNORENULL is determined by the format parameter of XMLExport, XMLImport and %XML.Reader.OpenFile. The default behavior for XMLIGNORENULL="runtime is the same as XMLIGNORENULL=0. Adding "ignorenull" to the format argument changes the behavior to that of XMLIGNORENULL=1. "ignorenull" shoud be separated by a comma from literal/encoded part of the format. Example values for format are "", ",ignorenull", "literal,ignorenull" and "encoded,ignorenull". Note that "inputonly" is equivalent to using ,ignorenull for XMLExport and not for %XML.Reader.
parameter XMLNAME = "control";
This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.


property action as %String(MAXLEN=250,XMLPROJECTION="attribute") [ InitialExpression = "applyFilter" ];
What action to take when this control is activated.
property actionDisplay as %String(MAXLEN=250,XMLPROJECTION="none") [ Transient ];
Transient display name for action.
property activeWhen as %String(MAXLEN=255,XMLPROJECTION="attribute");
Specifies when this control is enabled.
property activeWhenDisplay as %String(MAXLEN=250,XMLPROJECTION="none") [ Transient ];
Transient display name for activeWhen.
property controlClass as %String(MAXLEN=255,XMLPROJECTION="attribute");
Class name of component to user for this control when type is "custom". This is the name of a Zen control.
If the name does not include package, then "%ZEN.Component" is used.
If no name is provided, a default control is used.
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,click",XMLPROJECTION="attribute") [ InitialExpression = "widget" ];
Specifies where to place the control. If "click" then this defines what happens when a user clicks on an item within the widget.
property locationDisplay as %String(MAXLEN=250,XMLPROJECTION="none") [ Transient ];
Transient display name for location.
property name as %String(MAXLEN=255,XMLPROJECTION="attribute");
Identifying name for this control. This is used to logically identify the control.
property readOnly as %Boolean(XMLPROJECTION="attribute") [ InitialExpression = 0 ];
Indicate that this control is read only.
property size as %Integer(MINVAL=0,XMLPROJECTION="attribute");
Size to apply to the control (if the control accepts a size).
property target as %String(MAXLEN="",XMLPROJECTION="attribute");
Comma-delimited list of names of widgets to apply action to. If "*", then send event to all widgets.
property targetProperty as %String(MAXLEN="",XMLPROJECTION="attribute");
Name of property within widget to apply the action to. Typically this is the name of the filter being modified.
property targetPropertyDisplay as %String(MAXLEN=250,XMLPROJECTION="none");
Display name for targetProperty. (This value is saved so that we don't have to recompute it later; the value is only used for display purposes).
property text as %String(MAXLEN="",XMLPROJECTION="attribute");
Default text value for the control.
property timeout as %Integer(XMLPROJECTION="attribute");
Timeout value (seconds) when type is "timer".
property title as %String(MAXLEN="",XMLPROJECTION="attribute");
Title (tooltip) to display for the control.
property type as %String(MAXLEN=255,VALUELIST=",auto,dropdown,searchBox,button,hidden,radioSet,timer,custom",XMLPROJECTION="attribute");
General type of control to use.
If "custom", then the control specified by controlClass is used.
property typeDisplay as %String(MAXLEN=250,XMLPROJECTION="none") [ Transient ];
Transient display name for type.
property value as %String(MAXLEN="",XMLPROJECTION="attribute");
Default value for the control. If this starts with "@" then it is the name of a user defined-setting.
property valueList as %String(MAXLEN="",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.


method %CopyTo(pTarget As %DeepSee.Dashboard.Control) as %Status
Copy contents of this control to pTarget.