Skip to main content


class %DeepSee.UI.Dialog.ControlWizard extends %DeepSee.UI.Dialog.standardDialog

This dialog creates a new control for a dashboard widget. (Copied from old control edit dialog).

Property Inventory

Method Inventory


parameter APPLYBUTTON = 0;
Inherited description: If true, then this dialog displays an Apply button.


property actionTypes as list of %ZEN.Datatype.string;
List of action types.
Property methods: actionTypesBuildValueArray(), actionTypesCollectionToDisplay(), actionTypesCollectionToOdbc(), actionTypesDisplayToCollection(), actionTypesDisplayToLogical(), actionTypesGet(), actionTypesGetObject(), actionTypesGetObjectId(), actionTypesGetSwizzled(), actionTypesIsValid(), actionTypesLogicalToDisplay(), actionTypesLogicalToOdbc(), actionTypesNormalize(), actionTypesOdbcToCollection(), actionTypesSet(), actionTypesSetObject(), actionTypesSetObjectId()
property controlNumber as %ZEN.Datatype.string (ZENURL = "NUMBER");
Index of control within parent dialog list or "" for new.
Property methods: controlNumberDisplayToLogical(), controlNumberGet(), controlNumberIsValid(), controlNumberLogicalToDisplay(), controlNumberLogicalToOdbc(), controlNumberNormalize(), controlNumberSet()
property dashboardName as %ZEN.Datatype.string (ZENURL = "DASHBOARD");
Dashboard name.
Property methods: dashboardNameDisplayToLogical(), dashboardNameGet(), dashboardNameIsValid(), dashboardNameLogicalToDisplay(), dashboardNameLogicalToOdbc(), dashboardNameNormalize(), dashboardNameSet()
property dataSource as %ZEN.Datatype.string (ZENURL = "DATASOURCE");
Data source name.
Property methods: dataSourceDisplayToLogical(), dataSourceGet(), dataSourceIsValid(), dataSourceLogicalToDisplay(), dataSourceLogicalToOdbc(), dataSourceNormalize(), dataSourceSet()
property defaultCtrlText as %ZEN.Datatype.string;
Display text of the control default
Property methods: defaultCtrlTextDisplayToLogical(), defaultCtrlTextGet(), defaultCtrlTextIsValid(), defaultCtrlTextLogicalToDisplay(), defaultCtrlTextLogicalToOdbc(), defaultCtrlTextNormalize(), defaultCtrlTextSet()
property defaultCtrlValue as %ZEN.Datatype.string;
Logical value of the control default
Property methods: defaultCtrlValueDisplayToLogical(), defaultCtrlValueGet(), defaultCtrlValueIsValid(), defaultCtrlValueLogicalToDisplay(), defaultCtrlValueLogicalToOdbc(), defaultCtrlValueNormalize(), defaultCtrlValueSet()
property defaultTarget as %ZEN.Datatype.string (ZENURL = "TARGET");
This provides the ability to initialize the Target field on load.
Property methods: defaultTargetDisplayToLogical(), defaultTargetGet(), defaultTargetIsValid(), defaultTargetLogicalToDisplay(), defaultTargetLogicalToOdbc(), defaultTargetNormalize(), defaultTargetSet()
property widgetName as %ZEN.Datatype.string (ZENURL = "WIDGETNAME");
Name of widget.
Property methods: widgetNameDisplayToLogical(), widgetNameGet(), widgetNameIsValid(), widgetNameLogicalToDisplay(), widgetNameLogicalToOdbc(), widgetNameNormalize(), widgetNameSet()
property widgetNames as %ZEN.Datatype.csv (ZENURL = "WIDGETNAMES");
List of all widget names.
Property methods: widgetNamesDisplayToLogical(), widgetNamesGet(), widgetNamesIsValid(), widgetNamesLogicalToDisplay(), widgetNamesLogicalToOdbc(), widgetNamesNormalize(), widgetNamesSet()


method %OnAfterCreatePage() as %Status
Inherited description: Be sure to do ##super() when overriding.
method %OnGetSubtitle() as %String
Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.
method %OnGetTitle() as %String
Get the (localized) title string for the dialog. This should be implemented in a subclass.
clientmethod actionChange(clear) [ Language = javascript ]
User selected a new action type.
clientmethod browseDashboards() [ Language = javascript ]
Launch the dashboard finder.
clientmethod browseDataSources() [ Language = javascript ]
clientmethod browseTermLists() [ Language = javascript ]
clientmethod changeProperty() [ Language = javascript ]
Change of filter property.
clientmethod controlTypeChange(type) [ Language = javascript ]
User selected a new control type.
clientmethod getDialogValue() [ Language = javascript ]
Inherited description: Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
This client event is fired when the a popup page launched from this page fires an action.
clientmethod ondialogFinish(action) as %Boolean [ Language = javascript ]
This callback, if defined, is called when the user presses the OK or Apply action buttons. If this returns false, then the action is cancelled.
clientmethod ondialogStart() [ Language = javascript ]
This callback, if defined, is called when the dialog page is loaded.
clientmethod showDefaultValueEditor() [ Language = javascript ]
Launch the value editor.
clientmethod updateForm(val) [ Language = javascript ]
Updates the datasources field in the control wizard when the user picks a data source from a finder dialog.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab