Class Reference
%DeepSee.UI.Dialog.ControlWizard
Server:appadmin-00044-deployment-6bf4cbc86d-9f4xc
Instance:IRIS
User:SuperUser
 
-
  [USER] >  [%DeepSee] >  [UI] >  [Dialog] >  [ControlWizard]
Private  Storage

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).

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 9 15


Summary

This is a Zen Page class. 

Properties
%condition %import %includeFiles %page
%resource FirstFailed InvalidParam IsEMSReadOnly
ValidationErrorMsg actionTypes align aux
backgroundTimerInterval cellAlign cellSize cellStyle
cellVAlign children composite containerStyle
controlNumber cssLevel dashboardName dataSource
defaultCtrlText defaultCtrlValue defaultTarget dialogTitle
disabled disabledStyle dragAndDrop dragEnabled
dropEnabled enclosingClass enclosingStyle error
groupClass groupStyle height hidden
hideApplyButton hideCancelButton hint hintClass
hintStyle id index label
labelClass labelDisabledClass labelPosition labelStyle
layout name onafterdrag onbeforedrag
onclick ondrag ondrop onhide
onrefresh onshow onupdate parent
showLabel slice title tuple
useSVG useSoftModals valign visible
widgetName widgetNames width window
zenPersistentPopup

Methods
%AddChild %AddChildAfter %AddChildBefore %AddComponent
%AddImportedComponents %AddToSaveSet %ApplyURLParms %Attr
%BindExport %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %DrawAutoLogout
%DrawClassDefinitions %DrawComponentHTML %DrawHTML %DrawHTMLPage
%DrawJSStrings %DrawObjectDefinitions %DrawTitle %EnclosingDivId
%EndBackgroundMethod %EndScript %Eval %EvalC
%Extends %ForceClientRender %GetChildIndex %GetComponent
%GetComponentById %GetComponentByName %GetEventHandlers %GetLinks
%GetPageName %GetParameter %GetValueById %GetValueByName
%GetXMLName %IsA %IsModified %Link
%LinkCSS %LinkScript %MakeId %New
%NormalizeObject %ObjectModified %OnAddToPageAfter %OnAddToPageBefore
%OnAfterCreatePage %OnBeforeCreatePage %OnCreateApplication %OnCreatePage
%OnDetermineCSSLevel %OnDrawEnclosingDiv %OnDrawHTMLBody %OnDrawHTMLHead
%OnDrawHTMLMeta %OnDrawObjectProperties %OnFinishBackgroundTask %OnGetSubtitle
%OnGetTitle %OnMonitorBackgroundTask %OnMutateChildren %OnObjectSynch
%OnPreHTTP %OnSubmit %OnUseSoftModals %OnZENDeserialize
%OriginalNamespace %PackageName %QuoteValue %QuoteValueL10N
%RemoveChild %RemoveChildren %RemoveComponent %RemoveFromSaveSet
%RunBackgroundMethod %Self %SerializeObject %SetBackgroundMethodStatus
%SetErrorById %SetErrorByName %SetModified %SetValueById
%SetValueByName %SetValuesByName %StartScript %ValidateObject
%ZENVersion ConvertParameter Decrypt Encrypt
EscapeHTML EscapeURL EvalResult HyperEventCall
HyperEventHead Include InsertHiddenField InsertHiddenFields
IsPrivate JavaInstalled Link OnHTTPHeader
OnPage OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent Page QuoteJS
RewriteURL ShowError StartTimer StopTimer
ThrowError UnescapeHTML UnescapeURL XMLDTD
XMLExport XMLExportToStream XMLExportToString XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType actionChange
addChild addChildAfter addChildBefore adjustSize
browseDashboards browseDataSources browseTermLists btnApply
btnOK cancelPopup changeProperty childrenMutated
controlTypeChange correctIELayering createComponent createComponentNS
ctrlKeyDown deleteComponent dialogApply dialogCancel
dialogFinish dialogTitleGet disableButtons dragFinishHandler
dragHandler dragNotifyHandler dragStartHandler dropHandler
dropStartHandler endModal exposeComponent findElement
fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent firePopupAction
getChildIndex getComponent getComponentById getDialogValue
getEnclosingDiv getHidden getHintElement getLabelElement
getOpener getProperty getSettings getType
gotoPage invokeSuper isOfType launchPopupWindow
makeId onCreate onDelete onDisplayHandler
onEndModalHandler onPopupAction onRefreshContents onSerialize
onServerMethodCall onServerMethodError onServerMethodReturn onStartModalHandler
ondialogCancel ondialogFinish ondialogStart ondisabledHandler
onhandleAutoLogoutWarn onkeydownHandler onkeyupHandler onlayoutHandler
onloadHandler onlogoutHandler onoverlayHandler onresizeHandler
onunloadHandler onupdateHandler popupActionHandler refreshContents
removeChild render renderContents renderSVG
resetMsg setComponentId setHidden setOverlayMode
setProperty setPropertyAll setTraceOption showDefaultValueEditor
showMsg startModal startProgressBar stopProgressBar
stripWhitespaces updateForm validateRequired


Parameters

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

Properties

• property actionTypes as list of %ZEN.Datatype.string;
List of action types.
• property controlNumber as %ZEN.Datatype.string(ZENURL="NUMBER");
Index of control within parent dialog list or "" for new.
• property dashboardName as %ZEN.Datatype.string(ZENURL="DASHBOARD");
Dashboard name.
• property dataSource as %ZEN.Datatype.string(ZENURL="DATASOURCE");
Data source name.
• property defaultCtrlText as %ZEN.Datatype.string;
Display text of the control default
• property defaultCtrlValue as %ZEN.Datatype.string;
Logical value of the control default
• property defaultTarget as %ZEN.Datatype.string(ZENURL="TARGET");
This provides the ability to initialize the Target field on load.
• property widgetName as %ZEN.Datatype.string(ZENURL="WIDGETNAME");
Name of widget.
• property widgetNames as %ZEN.Datatype.csv(ZENURL="WIDGETNAMES");
List of all widget names.

Methods

• method %OnAfterCreatePage() as %Status
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.
• method actionChange(clear) [ Language = javascript ]
User selected a new action type.
• method browseDashboards() [ Language = javascript ]
Launch the dashboard finder.
• method browseDataSources() [ Language = javascript ]
• method browseTermLists() [ Language = javascript ]
• method changeProperty() [ Language = javascript ]
Change of filter property.
• method controlTypeChange(type) [ Language = javascript ]
User selected a new control type.
• method getDialogValue() [ Language = javascript ]
Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.
• method onPopupAction(popupName, action, value) [ Language = javascript ]
This client event is fired when the a popup page launched from this page fires an action.
• method 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.
• method ondialogStart() [ Language = javascript ]
This callback, if defined, is called when the dialog page is loaded.
• method showDefaultValueEditor() [ Language = javascript ]
Launch the value editor.
• method updateForm(val) [ Language = javascript ]
Updates the datasources field in the control wizard when the user picks a data source from a finder dialog.


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.