Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%ZEN] >  [StudioDocument] >  [ZENPageEditor]
Private  Storage   

deprecatedclass %ZEN.StudioDocument.ZENPageEditor extends %ZEN.StudioDocument.AbstractEditor

Editor logic for a Zen Page Studio Document.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 10


Summary

This is a Zen Page class. 

Properties
%condition %import %includeFiles %page
%resource DocumentID align aux
backgroundTimerInterval cellAlign cellSize cellStyle
cellVAlign children composite containerStyle
cssLevel disabled documentName dragAndDrop
dragEnabled dropEnabled enclosingClass enclosingStyle
error groupClass groupStyle height
hidden hint hintClass hintStyle
id index label labelClass
labelDisabledClass labelPosition labelStyle layout
modified name onafterdrag onbeforedrag
onclick ondrag ondrop onhide
onrefresh onshow onupdate parent
readOnly showLabel slice title
tuple useSVG useSoftModals valign
visible width window zenPersistentPopup
zoom

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 %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 %OnDrawHTMLHead %OnDrawHTMLMeta %OnDrawObjectProperties
%OnFinishBackgroundTask %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 DrawHTMLContent
Encrypt EscapeHTML EscapeURL GetClassName
HyperEventCall HyperEventHead Include InsertHiddenField
InsertHiddenFields IsPrivate JavaInstalled 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 cancelPopup
childrenMutated clearModified correctIELayering createComponent
createComponentNS deleteComponent dragFinishHandler dragHandler
dragNotifyHandler dragStartHandler dropHandler dropStartHandler
endModal exposeComponent findElement fireOnResizeEvent
fireOnUnloadEvent fireOnUpdateEvent firePopupAction getChildIndex
getComponent getComponentById getComponentXML getEnclosingDiv
getHidden getHintElement getLabelElement getOpener
getProperty getSettings getTargetPage getType
getZoom gotoPage invokeSuper isModified
isOfType isReadOnly launchPopupWindow makeId
onCanUndo onCmdCopy onCmdCut onCmdDelete
onCmdPaste onCmdRedo onCmdUndo onCreate
onDelete onDisplayHandler onEndModalHandler onGetDocument
onGetProperty onPopupAction onRefreshContents onSerialize
onServerMethodCall onServerMethodError onServerMethodReturn onSetDocument
onSetProperty onSetReadOnly onSetZoom onStartEditor
onStartModalHandler ondisabledHandler onhandleAutoLogoutWarn onkeydownHandler
onkeyupHandler onlayoutHandler onloadHandler onlogoutHandler
onoverlayHandler onresizeHandler onunloadHandler onupdateHandler
popupActionHandler raiseDocument raiseEvent raiseOpenDocument
raiseSelect refreshContents removeChild render
renderContents renderSVG selectComponent setComponentId
setHidden setModified setOverlayMode setProperty
setPropertyAll setResultsDiv setTraceOption setZoom
startModal startProgressBar stopProgressBar updateInspector


Parameters

• parameter DOMAIN = "%ZEN";
Localization domain

Methods

• 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 DrawHTMLContent(seed As %ZEN.Datatype.string) as %Status
DrawHTMLContent
• method getComponentXML(obj) [ Language = javascript ]
• method getTargetPage() [ Language = javascript ]
Return the target page loaded within this editor.
• method onCreate() [ Language = javascript ]
This client event, if present, is called when this component is instantiated. This allows for any additional client-side initialization for this object.
Note that this must be a client-side method.
• method onSetDocument(state) [ Language = javascript ]
Notification that the user has changed the XML version of this document.
state is the contents of the XML editor pane.
• method onSetProperty(prop, value) [ Language = javascript ]
User has changed a property value within the Inspector.
• method onStartEditor() [ Language = javascript ]
This client event, if present, is fired when editor is loaded.
• method selectComponent(page, obj, evt) [ Language = javascript ]
User has selected a component in the editor pane.
• method updateInspector() [ Language = javascript ]
Update the inspector with details on the selected component.


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