Skip to main content

%DeepSee.Component.controlDefinition

Class %DeepSee.Component.controlDefinition Extends %ZEN.Component.object [ System = 3 ]

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.

Parameters​

NAMESPACE​

Parameter NAMESPACE = "http://www.intersystems.com/deepsee";

Properties​

action​

Property action As %String(MAXLEN = 50);

What action to take when this control is activated.

target​

Property target As %String(MAXLEN = 250, XMLPROJECTION = "attribute");

Comma-delimited list of names of widgets to apply action to.

targetProperty​

Property targetProperty As %String(MAXLEN = 500, XMLPROJECTION = "attribute");

Actual specification of property within widget to apply the action to.

type​

Property type As %String(MAXLEN = 255, XMLPROJECTION = "attribute");

General type of control to use.

controlClass​

Property controlClass As %String(MAXLEN = 255, XMLPROJECTION = "attribute");

Class name of component to user for this control when type is "custom".

timeout​

Property timeout As %String(XMLPROJECTION = "attribute");

Timeout for this control when type is "timer".

label​

Property label As %String(MAXLEN = 255, XMLPROJECTION = "attribute");

Label to display for the control.

title​

Property title As %String(MAXLEN = 255, XMLPROJECTION = "attribute");

Title to display for the control.

size​

Property size As %Integer(MINVAL = 0, XMLPROJECTION = "attribute");

Size to apply to control.

readOnly​

Property readOnly As %Boolean(XMLPROJECTION = "attribute");

Is control read only?

value​

Property value As %String(MAXLEN = 255, XMLPROJECTION = "attribute");

Default value for the control.

valueRequired​

Property valueRequired As %Boolean [ InitialExpression = 0 ];

If set to true, the control must be assigned a value.

text​

Property text As %String(MAXLEN = 255, XMLPROJECTION = "attribute");

Default text value for the control.

location​

Property location As %String(MAXLEN = 50, VALUELIST = ",widget,dashboard", XMLPROJECTION = "attribute") [ InitialExpression = "widget" ];

Specifies where to place the control.

valueList​

Property valueList As %String(MAXLEN = 255, XMLPROJECTION = "attribute");

Comma-delimited list of permitted values for the control. If supplied this overrides a default list.

displayList​

Property displayList As %String(MAXLEN = 255, XMLPROJECTION = "attribute");

Comma-delimited list of display values for the filter. If supplied this overrides a default list.

activeWhen​

Property activeWhen As %String(MAXLEN = 255, XMLPROJECTION = "attribute");

Specifies when this control is enabled.