Home > Class Reference > ENSLIB namespace > %CSP.Portal.standardDialog
Private  Storage   

%CSP.Portal.standardDialog


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

Base class for Management Portal dialogs.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
5 4 7


Summary


This is a Zen Page class. 

Properties
%condition %import %includeFiles %page
%resource FirstFailed InvalidParam IsEMSReadOnly
ValidationErrorMsg align aux backgroundTimerInterval
cellAlign cellSize cellStyle cellVAlign
children composite containerStyle cssLevel
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 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 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 addChild addChildAfter
addChildBefore adjustSize btnApply btnOK
cancelPopup childrenMutated 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 onkeydownHandler onkeyupHandler onlayoutHandler
onloadHandler onlogoutHandler onoverlayHandler onresizeHandler
onunloadHandler onupdateHandler popupActionHandler refreshContents
removeChild render renderContents renderSVG
resetMsg setComponentId setHidden setOverlayMode
setProperty setPropertyAll setTraceOption showMsg
startModal startProgressBar stopProgressBar validateRequired

Subclasses
%CSP.Portal.ResourceDialog %CSP.UI.Portal.Audit.Detail %CSP.UI.Portal.Background.Dialog.DatabaseCompact
%CSP.UI.Portal.Background.Dialog.DatabaseDefragment %CSP.UI.Portal.Background.Dialog.DatabaseTruncate %CSP.UI.Portal.Dialog.ChangePassword
%CSP.UI.Portal.Dialog.ColumnPriv %CSP.UI.Portal.Dialog.DBActions %CSP.UI.Portal.Dialog.EncAddAdmin
%CSP.UI.Portal.Dialog.GenerateQRCode %CSP.UI.Portal.Dialog.LicenseActivate %CSP.UI.Portal.Dialog.MirrorDBActions
%CSP.UI.Portal.Dialog.MirrorPromote %CSP.UI.Portal.Dialog.PhoneProvider %CSP.UI.Portal.Dialog.ReportsExcelServerAction
%CSP.UI.Portal.Dialog.ReportsPrintServerAction %CSP.UI.Portal.Dialog.ReportsRenderServerAction %CSP.UI.Portal.Dialog.RoleResourceNew
%CSP.UI.Portal.Dialog.SQLParametersPrompt %CSP.UI.Portal.Dialog.SchemaPriv %CSP.UI.Portal.Dialog.WizardTemplate
%CSP.UI.Portal.Dialog.XSLTGatewayTest %CSP.UI.Portal.Dialog.ZenReportExcelServerAction %CSP.UI.Portal.Dialog.ZenReportPrintServerAction
%CSP.UI.Portal.Dialog.ZenReportRenderServerAction %CSP.UI.Portal.License.Print %CSP.UI.Portal.Mappings.Template
%CSP.UI.Portal.Mirror.Dialog.DNUpdates %CSP.UI.Portal.SQL.PrintQuery %CSP.UI.Portal.SQL.PrintTable
%CSP.UI.Portal.Sharding.Dialog.Assign %CSP.UI.Portal.Sharding.Dialog.Enable %CSP.UI.Portal.Sharding.Dialog.Settings
%CSP.UI.Portal.Sharding.Dialog.TableDetails %DeepSee.UI.Dialog.standardDialog %ZEN.Dialog.fileSelect
%ZEN.Dialog.namespaceSelect EnsPortal.Dialog.standardDialog

Parameters


• parameter APPLYBUTTON = 1;
If true, then this dialog displays an Apply button.
• parameter CSS3INCLUDES = "https://fonts.googleapis.com/css?family=Montserrat,https://fonts.googleapis.com/css?family=Source+Sans+Pro";
Comma-separated list of additional CSS3 include files for the page. If this is defined *and* this page is using CSS3, then the CSSINCLUDES parameter is ignored. If this is not defined *and* this page is using CSS3, then the CSSINCLUDES parameter is used.
• parameter CSSINCLUDES = "https://fonts.googleapis.com/css?family=Montserrat,https://fonts.googleapis.com/css?family=Source+Sans+Pro";
Comma-separated list of additional CSS include files for the page. If this page is using CSS3 then the CSS3INCLUDES parameter is used (if defined).
• parameter DOMAIN = "%Utility";
Localization domain
• parameter EMSSERVICE;

Properties


• property FirstFailed as %String;
Keeps track of the first form field that failed during validation.
• 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 IsEMSReadOnly as %Boolean [ InitialExpression = ##class(%SYS.EMS).IsReadOnly($classname()) ];
1 if we are on an EMS manager and viewing group data or on a managed instance, 0 otherwise.
• property ValidationErrorMsg as %String [ InitialExpression = $$$Text("There was a problem with the form. See the highlighted fields below.") ];

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.
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method resetMsg() [ Language = javascript ]
Clear message from idRespond html (usually placed above the editing portion of the page, but could be anywhere).
• method 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.
• method 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.