Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
Private  Storage   

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
6 12 16


Summary

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

Properties
%condition %import %includeFiles %page
%resource ARROWLEN BOXHEIGHT BOXMARGIN
ErrMessage FirstFailed HSPACE INDENT
InvalidParam IsEMSReadOnly LEGENDR RADIUS
SPACING TEXTMARGIN TEXTVOFFSET VSPACE
ValidationErrorMsg 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
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 Encrypt EscapeHTML EscapeURL
EvalResult GetHyperEventResources GetPathObject HyperEventCall
HyperEventHead Include InsertHiddenField InsertHiddenFields
IsPrivate JavaInstalled Link OnHTTPHeader
OnPage OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent Page QuoteJS
RewriteURL ShowError SimpleKeepAlive StartTimer
StopTimer ThrowError UnescapeHTML UnescapeURL
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
addChild addChildAfter addChildBefore addPopupSuffix
adjustSize adjustTextBox btnApply btnOK
cancelPopup checkEdit childrenMutated clientKeepAlive
correctIELayering createComponent createComponentNS ctrlKeyDown
deleteComponent dialogApply dialogCancel dialogFinish
dialogTitleGet disableButtons dragFinishHandler dragHandler
dragNotifyHandler dragStartHandler drawArrow drawElbowLine
drawLegend drawLegendBox drawProcess drawSVG
drawTextBox drawVLine 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 point
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.
• parameter CANCELBUTTON = 0;
If true, then this dialog displays a Cancel button.
• parameter CLOSEONENTER = 1;
Allow popup to close as if clicking button "OK" when user presses the ENTER key. Usually this parameter would be set to 1 if the dialog does not contain input fields.
• parameter CLOSEONESC = 1;
Allow popup to close as if clicking button "Cancel" or "X" when user presses the ESC key.
If this parameter has value 0, the popup will not close when user presses ESC.
If this parameter has value 1, the popup will be dismissed (canceled) when user presses ESC.
If this parameter has value 2, and the popup has button "OK", the popup will close as if clicking "OK".
• parameter OKBUTTON = 0;
• parameter RESOURCE = "%Ens_ProductionConfig:READ";
User needs READ permissions on the %Ens_ProductionConfig resource to view this page

Properties

• property ARROWLEN as %Integer [ InitialExpression = 50 ];
• property BOXHEIGHT as %Integer [ InitialExpression = 22 ];
height of the text box
• property BOXMARGIN as %Integer [ InitialExpression = 25 ];
• property ErrMessage as %ZEN.Datatype.string;
• property HSPACE as %Integer [ InitialExpression = 70 ];
• property INDENT as %Integer [ InitialExpression = 30 ];
• property LEGENDR as %Integer [ InitialExpression = 10 ];
radius of the rounded corners of the legend circles
• property RADIUS as %Integer [ InitialExpression = 10 ];
radius of the rounded corners of the boxes
• property SPACING as %Integer [ InitialExpression = 15 ];
spacing between boxes in legend
• property TEXTMARGIN as %Integer [ InitialExpression = 10 ];
size of the margin of the text inside the text box
• property TEXTVOFFSET as %Integer [ InitialExpression = 16 ];
distance of the vertical offset for the text y-attribute
• property VSPACE as %Integer [ InitialExpression = 32 ];

Methods

• method %OnAfterCreatePage() as %Status
Avoid writing out the session cookie if we are in a Studio session.
• 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 GetPathObject(ByRef pParms, Output pObject As %RegisteredObject) as %Status
• method adjustTextBox(svg, id, startX, maxX) [ Language = javascript ]
• method drawArrow(svg, x, y) [ Language = javascript ]
• method drawElbowLine(svg, x1, y1, x2, y2) [ Language = javascript ]
draw an elbow line between (x1,y1) and (x2,y2) we assume x1 • method drawLegend(svg) [ Language = javascript ]
• method drawLegendBox(svg, x, y, type, caption) [ Language = javascript ]
• method drawProcess(svg, x, y, process, type, id) [ Language = javascript ]
• method drawSVG(svg, err) [ Language = javascript ]
• method drawTextBox(svg, x, y, caption, type, id) [ Language = javascript ]
• method drawVLine(svg, x, y1, y2) [ 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 ondialogStart() [ Language = javascript ]
This callback, if defined, is called when the dialog page is loaded.
• method point(x, y) [ Language = javascript ]


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