Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [EnsPortal] >  [ServiceRegistry] >  [Dialog] >  [Action]
Private  Storage   

For InterSystems internal use only, subject to change without notice

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 6 14


Summary

This is a Zen Page class. It belongs to the application EnsPortal.Application.

Properties
%condition %import %includeFiles %page
%resource FirstFailed InvalidParam IsEMSReadOnly
Registry ValidationErrorMsg actKey actName
actService align aux backgroundTimerInterval
canEdit cellAlign cellSize cellStyle
cellVAlign children closeOnEnter closeOnEsc
composite containerStyle cssLevel dialogTitle
disabled disabledStyle dragAndDrop dragEnabled
dropEnabled enclosingClass enclosingStyle error
groupClass groupStyle hasButtons height
hidden hideApplyButton hideCancelButton hideOKButton
hint hintClass hintStyle id
index keepAliveInterval label labelClass
labelDisabledClass labelPosition labelStyle layout
msgNotPermitted name onafterdrag onbeforedrag
onclick ondrag ondrop onhide
onrefresh onshow onupdate parent
readOnly retValue showLabel slice
studioMode title tuple useSVG
useSoftModals valign visible width
window zenPersistentPopup

Methods
%AddCSPShareHyperevents %AddChild %AddChildAfter %AddChildBefore
%AddComponent %AddEnsExceptionHandler %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 DeleteExistingAction Encrypt EscapeHTML
EscapeURL EvalResult GetAction GetHyperEventResources
HyperEventCall HyperEventHead Include InsertHiddenField
InsertHiddenFields IsNameUnique IsNameValid IsPrivate
JavaInstalled Link OnHTTPHeader OnPage
OnPageError OnPostHTTP OnPostHyperEvent OnPreHTTP
OnPreHyperEvent Page QuoteJS RewriteURL
ShowError SimpleKeepAlive StartTimer StopTimer
SubmitAction ThrowError UnescapeHTML UnescapeURL
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
addChild addChildAfter addChildBefore addPopupSuffix
adjustSize btnApply btnOK cancelPopup
changeKey checkEdit childrenMutated clientKeepAlive
correctIELayering createComponent createComponentNS ctrlKeyDown
deleteComponent dialogApply dialogCancel dialogFinish
dialogTitleGet disableAllControls disableButtons disableControl
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 inResizeLoop initPopupSuffix
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
removePopupSuffix render renderContents renderSVG
resetMsg setComponentId setHidden setOverlayMode
setProperty setPropertyAll setTraceOption showMsg
startKeepAlive startModal startProgressBar stopKeepAlive
stopProgressBar validateRequired


Parameters

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

Properties

• property Registry as %ZEN.Datatype.string(ZENURL="REGISTRY") [ Final ];
• property actKey as %ZEN.Datatype.string(ZENURL="KEY");
key in the UI table - just here as part of the return value
• property actName as %ZEN.Datatype.string(ZENURL="ID");
Identity of contact.
• property actService as %ZEN.Datatype.string(ZENURL="SVC");
Contact Service
• property readOnly as %ZEN.Datatype.boolean(ZENURL="READONLY");
ReadOnly flag.
• property retValue as %String;

Methods

• 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 DeleteExistingAction(pID) [ ZenMethod ]
• method GetAction(ByRef pParms, Output pObject As %RegisteredObject) as %Status
• method IsNameUnique(pID As %String) as %Boolean [ ZenMethod ]
• method IsNameValid(pName As %String) as %Boolean [ ZenMethod ]
Test if the given name is valid.
• method SubmitAction(pCommand As %String, pProvider As %ZEN.Auxiliary.jsonProvider, pSubmitObject As %RegisteredObject, ByRef pResponseObject As %RegisteredObject) as %Status
Object submit handler JSON provider. This is called when the client clicks OK.
• method changeKey(actName) [ Language = javascript ]
• method disableAllControls(obj, propName) [ Language = javascript ]
• method disableControl(ctrlName) [ Language = javascript ]
• method getDialogValue() [ Language = javascript ]
Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.
• 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 onloadHandler() [ Language = javascript ]
Trigger keepAlive behaviour for the page.


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