Skip to main content


class %CSP.UI.Portal.ClassList extends %CSP.UI.Template.List

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.

Zen page for System Management Portal - Classes list

Property Inventory

Method Inventory


parameter AUTONS = 1;
Allow to change namespaces for this page.
parameter CSPURL = /csp/sys/exp/%CSP.UI.Portal.ClassList.zen;
Inherited description: This parameter is used to make sure that if multiple CSP applications are mapped to the same namespace that the CSP engine can correctly identify which class corresponds with which URL. If 'LockCSPName' is true (the default, defined in the CSP application) then you can only access this page if the url exactly matches this 'CSPURL'. You can set this parameter to "" if you wish to disable this check for this class. This check is applied for all CSP urls (cls/csp/zen).
If this page was compiled from a .csp file, then this parameter is automatically set to contain the url of this file used for compilation.
parameter HELPADDRESS = Home,Classes;
Inherited description: Each SMP page should set this link which points to the documentation anchor name.
parameter PAGENAME = ClassList;
Displayed name of this page.
parameter RESOURCE = %Development;
Security requirement


property ClassSpec as %String [ InitialExpression = "*.cls" ];
Property methods: ClassSpecDisplayToLogical(), ClassSpecGet(), ClassSpecIsValid(), ClassSpecLogicalToDisplay(), ClassSpecLogicalToOdbc(), ClassSpecNormalize(), ClassSpecSet()
property FILETYPE as %String [ InitialExpression = "Class" ];
Property methods: FILETYPEDisplayToLogical(), FILETYPEGet(), FILETYPEIsValid(), FILETYPELogicalToDisplay(), FILETYPELogicalToOdbc(), FILETYPENormalize(), FILETYPESet()
property NAMESPACE as %String (ZENURL = "$NAMESPACE");
Property methods: NAMESPACEDisplayToLogical(), NAMESPACEGet(), NAMESPACEIsValid(), NAMESPACELogicalToDisplay(), NAMESPACELogicalToOdbc(), NAMESPACENormalize(), NAMESPACESet()
property ShowSQL as %Boolean (ZENURL = "SQL");
Property methods: ShowSQLDisplayToLogical(), ShowSQLGet(), ShowSQLIsValid(), ShowSQLLogicalToDisplay(), ShowSQLLogicalToXSD(), ShowSQLNormalize(), ShowSQLSet(), ShowSQLXSDToLogical()
property writePERMISSION as %ZEN.Datatype.boolean [ InitialExpression = $System.Security.GetRoutinePermission($namespace) [ "WRITE" ];
Property methods: writePERMISSIONDisplayToLogical(), writePERMISSIONGet(), writePERMISSIONIsValid(), writePERMISSIONLogicalToDisplay(), writePERMISSIONLogicalToOdbc(), writePERMISSIONLogicalToXSD(), writePERMISSIONNormalize(), writePERMISSIONSet(), writePERMISSIONXSDToLogical()


method %OnAfterCreatePage() as %Status
Inherited description: Subclass to override. Always include code in this method.
method %OnGetPageName() as %String
Get the (localized) name of the page. This should be implemented in a subclass.
classmethod Delete(filetype) as %String [ ZenMethod ]
Delete selected classes now.
method DrawSQLColumn(table As %ZEN.Component.tablePane, name As %ZEN.Datatype.string, seed As %ZEN.Datatype.string) as %Status
method DrawTableHeader(pSeed As %String) as %Status
Draw the contents of the Table Header (the region between the diagram and the table).
method ExecuteRS(pRS As %Library.ResultSet, Output tSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %Boolean
Method for executing the mapping query.
method GetLastSearch() as %String
method OnDrawRibbon() as %Status
Inherited description: This is called in the middle of rendering the tool ribbon. Subclasses can inject their own content into the ribbon by writing it out in this method. This content is best wrapped within a single td element. It can also consist of multiple td elements.

To achieve a fixed position for elements within the ribbon, for a fixed width page you can use a single enclosing td that contains a table and a single tr, with td elements inside that single tr that contain your content for the ribbon.

To achieve a fixed position for elements within the ribbon, for a page whose width varies depending on its contents (thereby stretching the ribbon) you can use multiple td elements to contain your content and then a final td element that is empty and has width 40% (or so) to push your contents towards the left and keep them in their proper locations.

method OnGetRibbonInfo(Output pDisplay As %Boolean, Output pViewIcons As %List, Output pSortOptions As %List, Output pSearchBox As %Boolean, Output pRibbonTitle As %String, Output pCommands As %List) as %Status
Get information to display in the ribbon bar.
clientmethod changePage(newPage) [ Language = javascript ]
User clicked Routines or Globals to change page. Namespace will be carried over, not Database.
clientmethod doCompile() [ Language = javascript ]
clientmethod doDelete() [ Language = javascript ]
clientmethod doDoc(className, fullView) [ Language = javascript ]
Show class documatic in short view or full view. If fullView then open full Documatic.
clientmethod doExport() [ Language = javascript ]
clientmethod doFullView() [ Language = javascript ]
clientmethod doImport() [ Language = javascript ]
clientmethod doNamespace(selTypeChanged) [ Language = javascript ]
Changed Namespace <==> Database (implied namespace).
clientmethod doSearch() [ Language = javascript ]
User clicked Go to start search.
clientmethod doSelectRow(className) [ Language = javascript ]
clientmethod doSql() [ Language = javascript ]
clientmethod docClicked() [ Language = javascript ]
this method is called when user clicked the "Documentation" link. The value could not be passed with the correct escaping so we have to use the table value here.
clientmethod hideDoc() [ Language = javascript ]
clientmethod keyUp(zenEvent) [ Language = javascript ]
Check if user hit [Enter].
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
This client event is fired when the a popup page launched from this page fires an action.
clientmethod onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
clientmethod onresizeHandler() [ Language = javascript ]
This client event, if present, is fired when the page is resized.
clientmethod saveOptions() [ Language = javascript ]
Generic function to save user input options, called by doNamespace and doSearch, and when chkAlwaysFullView or chkAllowSelectRow is changed.
clientmethod sqlClicked(schema As %String, tablename As %String) [ Language = javascript ]
clientmethod updatePreference() [ Language = javascript ]
clientmethod updateView() [ Language = javascript ]
Update / Reload table. This overrides the one in Template.List.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab