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

abstract class %CSP.UI.Template.List extends %CSP.UI.Portal.Utils

This class is used internally by InterSystems IRIS. You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class.

This is the template for SMP pages with a Search pane on the left and Result pane on the right. It is primarily used by the System Explorer's Classes/Routines/Globals list pages.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 12 21


Summary

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

Properties
%condition %import %includeFiles %page
%resource BeginDate ClassURL CurrentColumn
CurrentSort DocPage EndDate Filter
FirstFailed GlobalURL HelpAddress ISREADONLY
InvalidParam IsEMSReadOnly IsEditForm LocatorHeader
MaxRows NamespaceList OnclickArray PID
ParentURL RoutineURL ShowGen ShowMap
ShowSys StdTitle TableMaxRows TablePageSize
ValidationErrorMsg aboutPage align aux
backgroundTimerInterval captionLastUpdate cellAlign cellSize
cellStyle cellVAlign children composite
contactPage containerStyle cssLevel currSortMode
currStep currViewMode disabled dragAndDrop
dragEnabled dropEnabled enableAutoRefresh enclosingClass
enclosingStyle error groupClass groupStyle
height hidden hint hintClass
hintStyle home homePage id
index label labelClass labelDisabledClass
labelPosition labelStyle layout lblTitle
limitPopups name onafterdrag onbeforedrag
onclick ondrag ondrop onhide
onrefresh onshow onupdate pageModified
parent searchKey showLabel slice
title tuple useSVG useSoftModals
valign visible width window
zenPersistentPopup

Methods
%AddChild %AddChildAfter %AddChildBefore %AddComponent
%AddImportedComponents %AddLocatorLinks %AddToSaveSet %ApplyURLParms
%Attr %BindExport %ChangeNS %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
%GetHomePage %GetHomeParam %GetLinks %GetLocatorLinks
%GetNavTableState %GetPageName %GetParameter %GetProductName
%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 %OnGetPageName %OnGetProductName %OnGetSmallMenu
%OnGetTitle %OnMonitorBackgroundTask %OnMutateChildren %OnObjectSynch
%OnPreHTTP %OnSubmit %OnUseSoftModals %OnZENDeserialize
%OriginalNamespace %PackageName %QuoteValue %QuoteValueL10N
%Register %RemoveChild %RemoveChildren %RemoveComponent
%RemoveFromSaveSet %RunBackgroundMethod %Self %SerializeObject
%SetBackgroundMethodStatus %SetErrorById %SetErrorByName %SetModified
%SetValueById %SetValueByName %SetValuesByName %StartScript
%ValidateObject %ZENVersion BuildMenu BuildMeter
CheckAllBlanks CheckContextLinks CheckEnterpriseManager ConvertParameter
Decrypt DoLogout DrawAutoRefresh DrawLocator
DrawRibbon DrawTitle Encrypt EscapeHTML
EscapeURL EvalResult FindDBDir FindDBName
GetCSPURL GetContextLinks GetDBList GetDocURL
GetExpandState GetHomePage GetNSList GetNewURL
GetQuickLinks GetRecentList HyperEventCall HyperEventHead
Include InsertHiddenField InsertHiddenFields IsPrivate
JavaInstalled LastUpdateTime Link OnDrawRibbon
OnGetRibbonInfo OnHTTPHeader OnPage OnPageError
OnPostHTTP OnPostHyperEvent OnPreHTTP OnPreHyperEvent
Page PrepareAction QuoteJS RegisterRecent
RewriteURL SaveExpandState SaveSelections ShowError
StartTimer StopTimer ThrowError UnescapeHTML
UnescapeURL UpdateAutoRefreshRate UpdateAutoRefreshState UpdateTableNavState
UpdateTableState XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType addChild addChildAfter addChildBefore
adjustSizes afterSave afterValidate cancelPopup
changePassword checkURLNamespace childrenMutated columnSort
correctIELayering createComponent createComponentNS deleteComponent
disableCommandButton doCancel doDoc doModified
doSearch dragFinishHandler dragHandler dragNotifyHandler
dragStartHandler dropHandler dropStartHandler enableCommandButton
endModal exposeComponent findElement findNSMatch
fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent firePopupAction
getChildIndex getComponent getComponentById getEnclosingDiv
getHidden getHintElement getLabelElement getOpener
getPageTitle getProperty getSelectedNamespace getSettings
getTime getTitleAreaHeight getType goHome
goMenu gotoNamespace gotoPage hideCommandButton
invokeSuper isButtonDisabled isOfType launchPopupWindow
logout makeId navMaxRowsChanged navPageSizeChanged
navigate onCreate onDelete onDisplayHandler
onEndModalHandler onPopupAction onRefreshContents onSerialize
onServerMethodCall onServerMethodError onServerMethodReturn onStartModalHandler
ondisabledHandler onhandleAutoLogoutWarn onkeydownHandler onkeyupHandler
onlayoutHandler onloadHandler onlogoutHandler onoverlayHandler
onresizeHandler onunloadHandler onupdateHandler popupActionHandler
refreshContents refreshHandler refreshkeyUp removeChild
render renderContents renderSVG resetMsg
searchBlur searchBoxHandler searchFocus searchKeyDown
searchKeyPress setComponentId setConnectivityStatusMsg setHidden
setModified setOverlayMode setPageTitle setProperty
setPropertyAll setRefreshMode setRefreshRate setSortMode
setSortModeHandler setTraceOption setViewMode setViewModeHandler
showAbout showCommandButton showContact showDocumentation
showExpand showHelp showMsg startModal
startProgressBar stopProgressBar switchNamespace toggleDetails
toggleSearch trimSpace updateTime updateView
validateRequired zeroFill

Subclasses
%CSP.UI.Portal.Audit.View %CSP.UI.Portal.ClassList %CSP.UI.Portal.GlobalList
%CSP.UI.Portal.Resources %CSP.UI.Portal.RoutineList %CSP.UI.Portal.SourceControl
%CSP.UI.Portal.TasksUpcoming

Parameters

• parameter PAGENAME = "Template List";
Displayed name of this page.

Properties

• property BeginDate as %String;
• property ClassURL as %String;
• property DocPage as %String;
• property EndDate as %String;
• property GlobalURL as %String;
• property MaxRows as %String;
• property NamespaceList as %String;
• property RoutineURL as %String;
• property ShowGen as %Boolean [ InitialExpression = "0" ];
• property ShowMap as %Boolean [ InitialExpression = "1" ];
• property ShowSys as %Boolean [ InitialExpression = "0" ];

Methods

• classmethod %ChangeNS(pNS As %String) as %Status
Proposed change to override %ChangeNS in %ZEN.Controller For SMP Explorer, we need to override the behavior of changing Namespace so that the error reporting is more appropriate.
• method %GetLocatorLinks(Output pLink) as %Status
Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)
• method %OnAfterCreatePage() as %Status
Subclass to override. Always include code in this method.
• classmethod FindDBDir(DBName) as %String [ ZenMethod ]
Given a DBName, return the DBDirectory. If we cannot find it, then return the first one we can find.
• classmethod FindDBName(DBDirectory) as %String [ ZenMethod ]
Given a DBDirectory, return the DBName
• classmethod GetDBList() as %String [ ZenMethod ]
Return Database list for UI's displayList. valueList (should not be loaded into