Class Reference
%ZEN.Template.ZENPageWizard
Server:appadmin-00044-deployment-6bf4cbc86d-9f4xc
Instance:IRIS
User:SuperUser
 
-
  [USER] >  [%ZEN] >  [Template] >  [ZENPageWizard]
Private  Storage

deprecatedclass %ZEN.Template.ZENPageWizard extends %ZEN.Template.studioTemplate

Studio Template: New ZEN Page.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
7 20


Summary

This is a Zen Page class. 

Properties
%condition %import %includeFiles %page
%resource DocumentName DocumentNamespace Language
Namespace Project SelectedText User
align aux backgroundTimerInterval cellAlign
cellSize cellStyle cellVAlign children
composite containerStyle cssLevel disabled
dragAndDrop dragEnabled dropEnabled enclosingClass
enclosingStyle error groupClass groupStyle
height helpId hidden 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 %AddToProject %AddToSaveSet %AddToSourceControl
%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
%GetDescHTML %GetDescHTML2 %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 %OnMonitorBackgroundTask
%OnMutateChildren %OnObjectSynch %OnPreHTTP %OnSubmit
%OnTemplateAction %OnUseSoftModals %OnZENDeserialize %OriginalNamespace
%PackageName %QuoteValue %QuoteValueL10N %RemoveChild
%RemoveChildren %RemoveComponent %RemoveFromSaveSet %RunBackgroundMethod
%Self %SerializeObject %SetBackgroundMethodStatus %SetClassName
%SetErrorById %SetErrorByName %SetModified %SetValueById
%SetValueByName %SetValuesByName %StartScript %TemplateHeader
%ValidateObject %ZENVersion ConvertParameter CreateApplicationRS
CreatePackageRS CreateSuperClassRS Decrypt Encrypt
EscapeHTML EscapeURL GetSVGContents HyperEventCall
HyperEventHead Include InsertHiddenField InsertHiddenFields
IsEnabled IsPrivate IsValidClassName JavaInstalled
Link LocalizeName 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 canFinish canGoBack
canGoNext cancelPopup cancelTemplate childrenMutated
correctIELayering createComponent createComponentNS deleteComponent
dragFinishHandler dragHandler dragNotifyHandler dragStartHandler
drawSamplePages dropHandler dropStartHandler endModal
exposeComponent findElement finishTemplate fireOnResizeEvent
fireOnUnloadEvent fireOnUpdateEvent firePopupAction formValidationHandler
getChildIndex getComponent getComponentById getEnclosingDiv
getHidden getHintElement getLabelElement getOpener
getProperty getSettings getType gotoPage
hasMultiplePages invokeSuper isOfType launchPopupWindow
makeId nextPage onCreate onDelete
onDisplayHandler onEndModalHandler onPopupAction onRefreshContents
onSerialize onServerMethodCall onServerMethodError onServerMethodReturn
onStartModalHandler ondisabledHandler onfinishHandler onhandleAutoLogoutWarn
onkeydownHandler onkeyupHandler onlayoutHandler onloadHandler
onlogoutHandler onoverlayHandler onresizeHandler onstartHandler
onunloadHandler onupdateHandler popupActionHandler previousPage
refreshContents removeChild render renderContents
renderSVG selectPageLayout setComponentId setHidden
setOverlayMode setProperty setPropertyAll setTraceOption
showDocumentation showHelp startModal startProgressBar
stopProgressBar updateForm updateState validateClassName


Parameters

• parameter DOMAIN = "%ZEN";
Domain used for localization.
• parameter TEMPLATEDESCRIPTION = "Create a new Zen page class.";
Short description of the template to show in Studio.
If DOMAIN is defined this will be localized.
• parameter TEMPLATEGROUP = "Zen";
If this is a TEMPLATEMODE="new" then this is the name of the tab in Studio this template is dispayed on. If none specified then it displays on 'Custom' tab.
• parameter TEMPLATEMODE = "new";
What type of template.
• parameter TEMPLATENAME = "Zen Page";
Name of the template to show in Studio.
If DOMAIN is defined this will be localized.
• parameter TEMPLATETITLE = "Zen Page Wizard";
Title of the template to show in the template window.
• parameter TEMPLATETYPE = "cls";
Comma separated list of 'CSP', 'CSR', 'MAC', 'INT', 'INC', 'BAS', 'CLS' to say what type of code this template generates; CSP, CSR, Routine, or Class code. You can also specify '*' for all types.

Methods

• method %GetDescHTML(pSeed As %String) as %Status
Provide contents of description component.
• method %GetDescHTML2(pSeed As %String) as %Status
Provide contents of description component.
• method %OnAfterCreatePage() as %Status
This callback is called after the server-side page object and all of its children are created.
Subclasses can override this to add, remove, or modify items within the page object model, or to provide values for controls.
• method %OnTemplateAction() as %Status
This method is called when the template is complete. Any output to the principal device is returned to the Studio.
• method CreateApplicationRS(Output tSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %ResultSet
Create the result set used by the Application dataCombo.
• method CreatePackageRS(Output tSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %ResultSet
Create the result set used by the Package dataCombo.
• method CreateSuperClassRS(Output tSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %ResultSet
Create the result set used by the SuperClass dataCombo.
• classmethod GetSVGContents(pIndex As %Integer) [ ZenMethod ]
Execute server-logic to get SVG contents for Owner-draw component.
• method canGoBack() [ Language = javascript ]
Return true if this template can go to the previous page (i.e., enable the Back button).
• method canGoNext() [ Language = javascript ]
Return true if this template can go to the next page (i.e., enable the Next button).
• method drawSamplePages(svg) [ Language = javascript ]
Owner-draw notification for owner1 component. This method creates content using client-side logic.
• method formValidationHandler() [ Language = javascript ]
Validation handler for form built-into template.
• method hasMultiplePages() [ Language = javascript ]
Return true if this template has more than one "page". This will display Back and Next buttons. This is implemented by subclasses.
• method nextPage() [ Language = javascript ]
Go to the next page of the template (if there is one).
• method onstartHandler() [ Language = javascript ]
This is called when the template is first displayed; This provides a chance to set focus etc.
• method previousPage() [ Language = javascript ]
Go to the previous page of the template (if there is one).
• method selectPageLayout(cls, name) [ Language = javascript ]
User selection of a page layout icon
• method updateForm() [ Language = javascript ]
Update state of controls on the wizard form.
• method validateClassName() [ Language = javascript ]


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