Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / %CSP.Portal.Template
Private  Storage   

%CSP.Portal.Template


abstract class %CSP.Portal.Template extends
%ZEN.Portal.standardPage, %ZEN.Portal.Utils

Template for Management Portal which System Management Portal, Ensemble, or HS can extend to.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
5 7 13


Summary


This is a Zen Page class. It belongs to the application %CSP.Portal.Application.

Properties
%ComponentClasses %ComponentNames %Components %CompositeList
%DeletedIds %NotifyList %RenderList %UserPackageList
%condition %import %includeFiles %page
%partial %resource %xmlOutputMode HelpAddress
ISREADONLY LocatorHeader ParentURL SVGClassList
StdTitle UserSVGPackageList aboutPage align
aux backgroundTimerInterval cellAlign cellSize
cellStyle cellVAlign children composite
containerStyle cssLevel currSortMode currStep
currViewMode designMode disabled dragAndDrop
dragEnabled dropEnabled dynamic enclosingClass
enclosingStyle error groupClass groupStyle
height hidden hint hintClass
hintStyle home homePage id
index inlineSVG isPopup isSoftModal
label labelClass labelDisabledClass labelPosition
labelStyle lastModalIndex layout lblTitle
limitPopups name nextIndex onafterdrag
onbeforedrag onclick ondrag ondrop
onhide onoverlay onrefresh onshow
onupdate overlayMode pageModified parent
popupParent renderFlag searchKey showLabel
slice title tuple useSVG
useSoftModals valign visible width
window zenPersistentPopup

Methods
%%OIDGet %AddChild %AddChildAfter %AddChildBefore
%AddComponent %AddImportedComponents %AddLocatorLinks %AddToSaveSet
%ApplyURLParms %Attr %BindExport %BuildObjectGraph
%ClassIsLatestVersion %ClassName %Close %ConstructClone
%CreateApplication %CreatePage %DetermineCSSLevel %DispatchClassMethod
%DispatchGetModified %DispatchGetProperty %DispatchMethod %DispatchSetModified
%DispatchSetMultidimProperty %DispatchSetProperty %DrawAutoLogout %DrawClassDefinition
%DrawClassDefinitions %DrawComponentHTML %DrawHTML %DrawHTMLPage
%DrawJSGetSettings %DrawJSSerialize %DrawJSStrings %DrawObjectDefinitions
%DrawObjectProperties %DrawSVGDef %DrawStyleDefinitions %DrawStyleHTML
%DrawStyleSVG %EnclosingDivId %EndBackgroundMethod %EndScript
%Eval %EvalC %Extends %ForceClientRender
%GenerateCode %GetAllNamespaces %GetChildIndex %GetClassCRC
%GetClassDepth %GetComponent %GetComponentById %GetComponentByName
%GetComponentPropertyById %GetDependentComponents %GetEventHandlers %GetHomePage
%GetHomeParam %GetIncludeFiles %GetIncludeInfo %GetLinks
%GetLocatorInfo %GetLocatorLinks %GetPageName %GetPaneContents
%GetParameter %GetProductName %GetSuperClassList %GetValueById
%GetValueByName %GetXMLName %IncrementCount %IsA
%IsEmbedded %IsModified %Link %LinkCSS
%LinkScript %MakeId %New %NormalizeObject
%ObjectModified %ObjectSynch %OnAddToPage %OnAddToPageAfter
%OnAddToPageBefore %OnAfterCreatePage %OnBeforeCreatePage %OnCreateApplication
%OnCreatePage %OnDetermineCSSLevel %OnDrawEnclosingDiv %OnDrawHTMLBody
%OnDrawHTMLHead %OnDrawHTMLMeta %OnDrawObjectProperties %OnFinishBackgroundTask
%OnGetPageName %OnGetProductName %OnGetSmallMenu %OnGetTitle
%OnMonitorBackgroundTask %OnMutateChildren %OnObjectSynch %OnPreHTTP
%OnSubmit %OnUseSoftModals %OnZENDeserialize %OriginalNamespace
%PackageName %QuoteValue %QuoteValueL10N %ReallyAddChild
%Register %RemoveChild %RemoveChildren %RemoveComponent
%RemoveFromSaveSet %RunBackgroundMethod %Self %SerializeObject
%SetBackgroundMethodStatus %SetErrorById %SetErrorByName %SetModified
%SetValueById %SetValueByName %SetValuesByName %StartScript
%ValidateObject %XMLGenerate %ZENDeserialize %ZENVersion
BuildMenu CheckAllBlanks CheckContextLinks CheckEnterpriseManager
ConvertParameter Decrypt DoLogout DrawLocator
DrawRibbon DrawTitle Encrypt EscapeHTML
EscapeURL EvalResult GetCSPURL GetContextLinks
GetDocPage GetHomePage GetNewURL GetQuickLinks
HyperEventBody HyperEventCall HyperEventFrame HyperEventHead
Include InsertHiddenField InsertHiddenFields InvokeClassMethod
InvokeInstanceMethod IsPrivate Link LoadZenComponent
MonitorBackgroundTask OnDrawRibbon OnGetRibbonInfo OnHTTPHeader
OnPage OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent Page QuoteJS
ReallyRefreshContents RegisterRecent RewriteURL ShowError
StartTimer StopTimer ThrowError UnescapeHTML
UnescapeURL XMLAfterExport XMLBeforeExport XMLDTD
XMLExport XMLExportInternal XMLExportToStream XMLExportToString
XMLGetSchemaImports XMLImport XMLImportInternal XMLIsObjectEmpty
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
addChild addChildAfter addChildBefore backgroundTimerHandler
cancelPopup changePassword childrenMutated clearBackgroundTask
correctIELayering createComponent createComponentNS deleteComponent
disableCommandButton dragFinishHandler dragHandler dragNotifyHandler
dragStartHandler dropHandler dropStartHandler enableCommandButton
endModal exposeComponent findElement fireOnLoadEvent
fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent firePopupAction
getChildIndex getComponent getComponentById getEnclosingDiv
getHidden getHintElement getLabelElement getOpener
getProperty getSettings getTargetPage getTitleAreaHeight
getType goHome goMenu gotoNamespace
gotoPage hideCommandButton invokeSuper isOfType
launchPopupWindow logout makeId navigate
onCreate onDelete onDisplayHandler onEndModalHandler
onPopupAction onRefreshContents onSerialize onServerMethodCall
onServerMethodError onServerMethodReturn onStartModalHandler ondisabledHandler
onkeydownHandler onkeyupHandler onlayoutHandler onloadHandler
onlogoutHandler onoverlayHandler onresizeHandler onunloadHandler
onupdateHandler popupActionHandler progressBarHandler refreshContents
removeChild render renderContents renderSVG
searchBlur searchBoxHandler searchFocus searchKeyDown
searchKeyPress setBackgroundTask setComponentId setConnectivityStatusMsg
setHidden setModified setOverlayMode setProperty
setPropertyAll setSortMode setSortModeHandler setTraceOption
setViewMode setViewModeHandler showAbout showCommandButton
showDocumentation showHelp startModal startProgressBar
stopProgressBar switchNamespace testConnectivity updateControlsInGroup

Subclasses
%CSP.Portal.SourceControl.Dialog.Manager %CSP.UI.Portal.Template EnsPortal.Template.standardPage

Parameters


• parameter APPLICATION = "%CSP.Portal.Application";
Class name of application this page belongs to.
• parameter AUTONS = 1;
Allow pages to auto-switch namespaces if $NAMESPACE is specified
• parameter DOMAIN = "%Utility";
Domain used for localization.
• parameter PAGENAME = "Template for Management Portal";
Displayed name of this page.
• parameter PARENTPAGE;
This parameter defines the parent page for this page.
If the name ends in .csp, then the parent is assumed to be an autopage-enabled CSP page.
If the name ends in .cls, then the parent is assumed to be a Zen page.
This is used to automate the construction of the locator bar for this page and to build the index between portal pages and documentation.
The %GetLocatorInfo method is used to get this information.

Properties


• property HelpAddress as %ZEN.Datatype.string;
The help address that links to the "Help" (next to the "Logout" link) documentation
• property ISREADONLY as %Boolean [ InitialExpression = 0 ];
Indicates whether the page is read only due to EMS control.
• property LocatorHeader as %ZEN.Datatype.caption;
The text that is shown in TitlePane above the license
• property ParentURL as %String [ InitialExpression = ..Link($ZCVT(..#PARENTPAGE,"O","URL")) ];
Parent URL that Cancel and Save should return to
• property StdTitle as %ZEN.Datatype.string [ InitialExpression = ..#PAGENAME ];
Text shown on page or browser tab header
• property home as %ZEN.Datatype.string(ZENURL="home");
home value to return to Home page to.
• property lblTitle as %ZEN.Datatype.string [ InitialExpression = ..#PAGENAME ];
Text shown between locator bar and details pane (form or table)

Methods


• method %AddLocatorLinks(pLocator As %ZEN.Component.locatorBar, pLocalize As %String, pParam As %String = "", pIsNew As %Boolean = 0)
Utility method. Add the locator links defined by the LOCATORINFO parameter to the given locator bar.
pLocalize is an array from calling DocLocalize for a page. (optional)
pParam contains extra parameters for the last or current page link. (optional) pIsNew is the flag indicating this page is for "Add" rather than "Edit". If it's true then we use a different locator text if defined.
• classmethod %GetHomePage() as %String
This method is used by SMP to return home page. Set home to %session if not null for later use.
• method %GetHomeParam() as %String
Used to return "home" parameter for building return home links in sub-classes.
• classmethod %GetLocatorInfo(Output pInfo)
Return an array of locator info for this page. This takes the form:
pInfo(n) = $LB(name,url)
• method %GetLocatorLinks(Output pLink) as %Status
Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)
Subclasses with extra layers of locator links or other than "Configuration" please override.
• classmethod %GetProductName() as %String
Get the product name for the page.Called from none-Zen classes in SMP.
• method %OnGetPageName() as %String
Get the (localized) name of the page. This should be implemented in a subclass.
• method %OnGetTitle() as %String
Get the (localized) title string for the page. This should be implemented in a subclass.
• classmethod CheckAllBlanks(string) as %Boolean [ ZenMethod ]
• classmethod EvalResult(pSC) as %String
Return tmsg. 1 means success. Otherwise error message in HTML.
• classmethod GetHomePage() as %String [ ZenMethod ]
This method allows us to get the home page URL from JavaScript.
• classmethod RegisterRecent(pTitle)
Recent item is only registered at the Home level.
• method showDocumentation(topic, anchor, url) [ Language = javascript ]