Home > Class Reference > ENSLIB namespace > %CSP.UI.Portal.Namespaces

%CSP.UI.Portal.Namespaces

class %CSP.UI.Portal.Namespaces extends %CSP.UI.Portal.Utils

System Management Portal - System Administration - Namespaces

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter AUTONS = 0;
Do not switch namespace for this page: it needs to stay in %SYS
parameter CSPURL = /csp/sys/mgr/%CSP.UI.Portal.Namespaces.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 EMSSERVICE = Namespace;
parameter HELPADDRESS = Home,Configuration,Namespaces;
Inherited description: Each SMP page should set this link which points to the documentation anchor name.
parameter PAGENAME = Namespaces;
Displayed name of this page.
parameter RESOURCE = %Admin_Manage;
Security requirement

Properties (Including Private)

property colDelete as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Delete") ];
Store translated targetCol linkCaption for
Property methods: colDeleteDisplayToLogical(), colDeleteGet(), colDeleteIsValid(), colDeleteLogicalToDisplay(), colDeleteLogicalToOdbc(), colDeleteNormalize(), colDeleteSet()

Methods (Including Private)

method %OnAfterCreatePage() as %Status
Inherited description: Be sure to do ##super() when overriding.
method %OnGetPageName() as %String
Get the (localized) name of the page. This should be implemented in a subclass.
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 doDataLocation(ns) [ Language = javascript ]
clientmethod doDelete(ns) [ Language = javascript ]
clientmethod doEdit(ns) [ Language = javascript ]
clientmethod doMap(mapType, ns) [ Language = javascript ]
clientmethod doNew() [ Language = javascript ]
clientmethod filterChanged(value, tableID) [ Language = javascript ]
User entered something in to the filter. Re-load the table with filter value.
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
This client event, if present, is fired when the a popup page launched from this page fires an action.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)