Skip to main content


serial class %DeepSee.Dashboard.Control extends %Library.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).

Property Inventory

Method Inventory


parameter NAMESPACE =;
Inherited description: 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;
Inherited description: 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;
Inherited description: 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 methods: actionDisplayToLogical(), actionGet(), actionIsValid(), actionLogicalToDisplay(), actionLogicalToOdbc(), actionNormalize(), actionSet()
property actionDisplay as %String (MAXLEN = 250, XMLPROJECTION = "none") [ Transient ];
Transient display name for action.
Property methods: actionDisplayDisplayToLogical(), actionDisplayGet(), actionDisplayIsValid(), actionDisplayLogicalToDisplay(), actionDisplayLogicalToOdbc(), actionDisplayNormalize(), actionDisplaySet()
property activeWhen as %String (MAXLEN = 255, XMLPROJECTION = "attribute");
Specifies when this control is enabled.
Property methods: activeWhenDisplayToLogical(), activeWhenGet(), activeWhenIsValid(), activeWhenLogicalToDisplay(), activeWhenLogicalToOdbc(), activeWhenNormalize(), activeWhenSet()
property activeWhenDisplay as %String (MAXLEN = 250, XMLPROJECTION = "none") [ Transient ];
Transient display name for activeWhen.
Property methods: activeWhenDisplayDisplayToLogical(), activeWhenDisplayGet(), activeWhenDisplayIsValid(), activeWhenDisplayLogicalToDisplay(), activeWhenDisplayLogicalToOdbc(), activeWhenDisplayNormalize(), activeWhenDisplaySet()
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 methods: controlClassDisplayToLogical(), controlClassGet(), controlClassIsValid(), controlClassLogicalToDisplay(), controlClassLogicalToOdbc(), controlClassNormalize(), controlClassSet()
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 methods: displayListDisplayToLogical(), displayListGet(), displayListIsValid(), displayListLogicalToDisplay(), displayListLogicalToOdbc(), displayListNormalize(), displayListSet()
property label as %String (MAXLEN = 255, XMLPROJECTION = "attribute");
Label to display for the control.
Property methods: labelDisplayToLogical(), labelGet(), labelIsValid(), labelLogicalToDisplay(), labelLogicalToOdbc(), labelNormalize(), labelSet()
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 methods: locationDisplayToLogical(), locationGet(), locationIsValid(), locationLogicalToDisplay(), locationLogicalToOdbc(), locationNormalize(), locationSet()
property locationDisplay as %String (MAXLEN = 250, XMLPROJECTION = "none") [ Transient ];
Transient display name for location.
Property methods: locationDisplayDisplayToLogical(), locationDisplayGet(), locationDisplayIsValid(), locationDisplayLogicalToDisplay(), locationDisplayLogicalToOdbc(), locationDisplayNormalize(), locationDisplaySet()
property name as %String (MAXLEN = 255, XMLPROJECTION = "attribute");
Identifying name for this control. This is used to logically identify the control.
Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property readOnly as %Boolean (XMLPROJECTION = "attribute") [ InitialExpression = 0 ];
Indicate that this control is read only.
Property methods: readOnlyDisplayToLogical(), readOnlyGet(), readOnlyIsValid(), readOnlyLogicalToDisplay(), readOnlyLogicalToXSD(), readOnlyNormalize(), readOnlySet(), readOnlyXSDToLogical()
property size as %Integer (MINVAL = 0, XMLPROJECTION = "attribute");
Size to apply to the control (if the control accepts a size).
Property methods: sizeDisplayToLogical(), sizeGet(), sizeIsValid(), sizeLogicalToDisplay(), sizeNormalize(), sizeSet(), sizeXSDToLogical()
property target as %String);
Comma-delimited list of names of widgets to apply action to. If "*", then send event to all widgets.
Property methods: targetDisplayToLogical(), targetGet(), targetIsValid(), targetLogicalToDisplay(), targetLogicalToOdbc(), targetNormalize(), targetSet()
property targetProperty as %String);
Name of property within widget to apply the action to. Typically this is the name of the filter being modified.
Property methods: targetPropertyDisplayToLogical(), targetPropertyGet(), targetPropertyIsValid(), targetPropertyLogicalToDisplay(), targetPropertyLogicalToOdbc(), targetPropertyNormalize(), targetPropertySet()
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 methods: targetPropertyDisplayDisplayToLogical(), targetPropertyDisplayGet(), targetPropertyDisplayIsValid(), targetPropertyDisplayLogicalToDisplay(), targetPropertyDisplayLogicalToOdbc(), targetPropertyDisplayNormalize(), targetPropertyDisplaySet()
property text as %String);
Default text value for the control.
Property methods: textDisplayToLogical(), textGet(), textIsValid(), textLogicalToDisplay(), textLogicalToOdbc(), textNormalize(), textSet()
property timeout as %Integer (XMLPROJECTION = "attribute");
Timeout value (seconds) when type is "timer".
Property methods: timeoutDisplayToLogical(), timeoutGet(), timeoutIsValid(), timeoutLogicalToDisplay(), timeoutNormalize(), timeoutSet(), timeoutXSDToLogical()
property title as %String);
Title (tooltip) to display for the control.
Property methods: titleDisplayToLogical(), titleGet(), titleIsValid(), titleLogicalToDisplay(), titleLogicalToOdbc(), titleNormalize(), titleSet()
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 methods: typeDisplayToLogical(), typeGet(), typeIsValid(), typeLogicalToDisplay(), typeLogicalToOdbc(), typeNormalize(), typeSet()
property typeDisplay as %String (MAXLEN = 250, XMLPROJECTION = "none") [ Transient ];
Transient display name for type.
Property methods: typeDisplayDisplayToLogical(), typeDisplayGet(), typeDisplayIsValid(), typeDisplayLogicalToDisplay(), typeDisplayLogicalToOdbc(), typeDisplayNormalize(), typeDisplaySet()
property value as %String);
Default value for the control. If this starts with "@" then it is the name of a user defined-setting.
Property methods: valueDisplayToLogical(), valueGet(), valueIsValid(), valueLogicalToDisplay(), valueLogicalToOdbc(), valueNormalize(), valueSet()
property valueList as %String);
Comma-delimited list of permitted values for the control. If supplied this overrides a default list.
Property methods: valueListDisplayToLogical(), valueListGet(), valueListIsValid(), valueListLogicalToDisplay(), valueListLogicalToOdbc(), valueListNormalize(), valueListSet()
property valueRequired as %Boolean [ InitialExpression = 0 ];
If set to true, the control must be assigned a value.
Property methods: valueRequiredDisplayToLogical(), valueRequiredGet(), valueRequiredIsValid(), valueRequiredLogicalToDisplay(), valueRequiredLogicalToXSD(), valueRequiredNormalize(), valueRequiredSet(), valueRequiredXSDToLogical()


method %CopyTo(ByRef pTarget) as %Status
Copy contents of this control to pTarget.
method %CopyToDao(ByRef pTarget As %DynamicObject = $$$NULLOREF) as %Status
Copy contents to a dynamic object
method %CopyToDef(ByRef pTarget As %DeepSee.Dashboard.Control) as %Status
Copy contents to a structured Control definition

Inherited Members

Inherited Methods

FeedbackOpens in a new tab