Skip to main content

%CSP.Portal.standardDialog

abstract class %CSP.Portal.standardDialog extends %ZEN.Dialog.standardDialog

Base class for Management Portal dialogs.

Property Inventory

Method Inventory

Parameters

parameter APPLYBUTTON = 1;
Inherited description: If true, then this dialog displays an Apply button.
parameter DOMAIN = %Utility;
Inherited description: Localization domain
parameter EMSSERVICE;
parameter IFRAMEALLOWED = 0;
Allow pages to have iframes by not setting x-frame-options: same origin. Set default for Management Portal as iframes are not allowed.

Properties

property FirstFailed as %String;
Keeps track of the first form field that failed during validation.
Property methods: FirstFailedDisplayToLogical(), FirstFailedGet(), FirstFailedIsValid(), FirstFailedLogicalToDisplay(), FirstFailedLogicalToOdbc(), FirstFailedNormalize(), FirstFailedSet()
property InvalidParam as %Boolean [ InitialExpression = 0 ];
Set to 1 in %OnAfterCreatePage if a URI parameter is invalid. Used to disable command buttons in onloadHandler().
Property methods: InvalidParamDisplayToLogical(), InvalidParamGet(), InvalidParamIsValid(), InvalidParamLogicalToDisplay(), InvalidParamLogicalToXSD(), InvalidParamNormalize(), InvalidParamSet(), InvalidParamXSDToLogical()
property IsEMSReadOnly as %Boolean [ InitialExpression = 0 ];
1 if we are on an EMS manager and viewing group data or on a managed instance, 0 otherwise. Property IsEMSReadOnly As %Boolean [ InitialExpression = {##class(%SYS.EMS).IsReadOnly($classname())} ];
Property methods: IsEMSReadOnlyDisplayToLogical(), IsEMSReadOnlyGet(), IsEMSReadOnlyIsValid(), IsEMSReadOnlyLogicalToDisplay(), IsEMSReadOnlyLogicalToXSD(), IsEMSReadOnlyNormalize(), IsEMSReadOnlySet(), IsEMSReadOnlyXSDToLogical()
property ValidationErrorMsg as %String [ InitialExpression = $$$Text("There was a problem with the form. See the highlighted fields below.") ];
Property methods: ValidationErrorMsgDisplayToLogical(), ValidationErrorMsgGet(), ValidationErrorMsgIsValid(), ValidationErrorMsgLogicalToDisplay(), ValidationErrorMsgLogicalToOdbc(), ValidationErrorMsgNormalize(), ValidationErrorMsgSet()

Methods

method %DrawTitle(pSeed As %String) as %Status
Provide HTML for html title box.
Default implementation displays the standard Zen title bar.
method %OnAfterCreatePage() as %Status
Be sure to do ##super() when overriding.
classmethod EvalResult(pSC) as %String
Return tmsg. 1 means success. Otherwise error message in HTML.
clientmethod onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
clientmethod resetMsg() [ Language = javascript ]
Clear message from idRespond html (usually placed above the editing portion of the page, but could be anywhere).
clientmethod showMsg(msg, isErr) [ Language = javascript ]
Display message in idRespond html (usually placed above the editing portion of the page, but could be anywhere). isErr: if 1 is passed in then the color will be changed to red; If 0 is passed in then the color is changed to #4D3926; If nothing is passed in, then the color is unchanged. This allows developers to set their own style/class and still be able to use showMsg.
clientmethod validateRequired(ctl, pass, type, checkRange, minVal, maxVal) as %Boolean [ Language = javascript ]
Validate the control value. pass is either "true" or "false" indicating if there is already a field that failed validation. Type is "N" for numeric or "S" for string. If numeric, if checkRange is true, we additionally validate that the number is between minVal and maxVal, inclusive.

Inherited Members

Inherited Properties

Inherited Methods

Subclasses

FeedbackOpens in a new tab