Skip to main content


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.

Property Inventory


parameter NAMESPACE =;
Inherited description: This is the XML namespace used for library components.


property action as %String (MAXLEN = 50);
What action to take when this control is activated.
Property methods: actionDisplayToLogical(), actionGet(), actionIsValid(), actionLogicalToDisplay(), actionLogicalToOdbc(), actionNormalize(), actionSet()
property activeWhen as %String (MAXLEN = 255, XMLPROJECTION = "attribute");
Specifies when this control is enabled.
Property methods: activeWhenDisplayToLogical(), activeWhenGet(), activeWhenIsValid(), activeWhenLogicalToDisplay(), activeWhenLogicalToOdbc(), activeWhenNormalize(), activeWhenSet()
property controlClass as %String (MAXLEN = 255, XMLPROJECTION = "attribute");
Class name of component to user for this control when type is "custom".
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", XMLPROJECTION = "attribute") [ InitialExpression = "widget" ];
Specifies where to place the control.
Property methods: locationDisplayToLogical(), locationGet(), locationIsValid(), locationLogicalToDisplay(), locationLogicalToOdbc(), locationNormalize(), locationSet()
property readOnly as %Boolean (XMLPROJECTION = "attribute");
Is control read only?
Property methods: readOnlyDisplayToLogical(), readOnlyGet(), readOnlyIsValid(), readOnlyLogicalToDisplay(), readOnlyLogicalToXSD(), readOnlyNormalize(), readOnlySet(), readOnlyXSDToLogical()
property size as %Integer (MINVAL = 0, XMLPROJECTION = "attribute");
Size to apply to control.
Property methods: sizeDisplayToLogical(), sizeGet(), sizeIsValid(), sizeLogicalToDisplay(), sizeNormalize(), sizeSet(), sizeXSDToLogical()
property target as %String (MAXLEN = 250, XMLPROJECTION = "attribute");
Comma-delimited list of names of widgets to apply action to.
Property methods: targetDisplayToLogical(), targetGet(), targetIsValid(), targetLogicalToDisplay(), targetLogicalToOdbc(), targetNormalize(), targetSet()
property targetProperty as %String (MAXLEN = 500, XMLPROJECTION = "attribute");
Actual specification of property within widget to apply the action to.
Property methods: targetPropertyDisplayToLogical(), targetPropertyGet(), targetPropertyIsValid(), targetPropertyLogicalToDisplay(), targetPropertyLogicalToOdbc(), targetPropertyNormalize(), targetPropertySet()
property text as %String (MAXLEN = 255, XMLPROJECTION = "attribute");
Default text value for the control.
Property methods: textDisplayToLogical(), textGet(), textIsValid(), textLogicalToDisplay(), textLogicalToOdbc(), textNormalize(), textSet()
property timeout as %String (XMLPROJECTION = "attribute");
Timeout for this control when type is "timer".
Property methods: timeoutDisplayToLogical(), timeoutGet(), timeoutIsValid(), timeoutLogicalToDisplay(), timeoutLogicalToOdbc(), timeoutNormalize(), timeoutSet()
property title as %String (MAXLEN = 255, XMLPROJECTION = "attribute");
Title to display for the control.
Property methods: titleDisplayToLogical(), titleGet(), titleIsValid(), titleLogicalToDisplay(), titleLogicalToOdbc(), titleNormalize(), titleSet()
property type as %String (MAXLEN = 255, XMLPROJECTION = "attribute");
General type of control to use.
Property methods: typeDisplayToLogical(), typeGet(), typeIsValid(), typeLogicalToDisplay(), typeLogicalToOdbc(), typeNormalize(), typeSet()
property value as %String (MAXLEN = 255, XMLPROJECTION = "attribute");
Default value for the control.
Property methods: valueDisplayToLogical(), valueGet(), valueIsValid(), valueLogicalToDisplay(), valueLogicalToOdbc(), valueNormalize(), valueSet()
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 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()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab