Home > Class Reference > %SYS namespace > %CSP.UI.Portal.RoutineList

%CSP.UI.Portal.RoutineList

class %CSP.UI.Portal.RoutineList 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 - Routines list

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter AUTONS = 1;
Allow to change namespaces for this page.
parameter CSPURL = /csp/sys/exp/%CSP.UI.Portal.RoutineList.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,Routines;
Inherited description: Each SMP page should set this link which points to the documentation anchor name.
parameter PAGENAME = RoutineList;
Displayed name of this page.
parameter RECENT = 0;
Inherited description: If true, register visits to this page in the recent list.
parameter RESOURCE = %Development;
Security requirement

Properties (Including Private)

property CurrentColumn as %ZEN.Datatype.string [ InitialExpression = "Name" ];
Property methods: CurrentColumnDisplayToLogical(), CurrentColumnGet(), CurrentColumnIsValid(), CurrentColumnLogicalToDisplay(), CurrentColumnLogicalToOdbc(), CurrentColumnNormalize(), CurrentColumnSet()
property CurrentSort as %ZEN.Datatype.string [ InitialExpression = "asc" ];
Property methods: CurrentSortDisplayToLogical(), CurrentSortGet(), CurrentSortIsValid(), CurrentSortLogicalToDisplay(), CurrentSortLogicalToOdbc(), CurrentSortNormalize(), CurrentSortSet()
property ExecuteSpec as %String [ InitialExpression = "*.mac" ];
Actual spec that the query executed
Property methods: ExecuteSpecDisplayToLogical(), ExecuteSpecGet(), ExecuteSpecIsValid(), ExecuteSpecLogicalToDisplay(), ExecuteSpecLogicalToOdbc(), ExecuteSpecNormalize(), ExecuteSpecSet()
property FILETYPE as %String [ InitialExpression = "Routine" ];
Property methods: FILETYPEDisplayToLogical(), FILETYPEGet(), FILETYPEIsValid(), FILETYPELogicalToDisplay(), FILETYPELogicalToOdbc(), FILETYPENormalize(), FILETYPESet()
property FindPage as %String;
Property methods: FindPageDisplayToLogical(), FindPageGet(), FindPageIsValid(), FindPageLogicalToDisplay(), FindPageLogicalToOdbc(), FindPageNormalize(), FindPageSet()
property NAMESPACE as %String (ZENURL = "$NAMESPACE");
Property methods: NAMESPACEDisplayToLogical(), NAMESPACEGet(), NAMESPACEIsValid(), NAMESPACELogicalToDisplay(), NAMESPACELogicalToOdbc(), NAMESPACENormalize(), NAMESPACESet()
property colCode as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Code") ];
Store translated targetCol linkCaption for
Property methods: colCodeDisplayToLogical(), colCodeGet(), colCodeIsValid(), colCodeLogicalToDisplay(), colCodeLogicalToOdbc(), colCodeNormalize(), colCodeSet()
property writePERMISSION as %ZEN.Datatype.boolean [ InitialExpression = $System.Security.GetRoutinePermission($namespace)["WRITE" ];
Property methods: writePERMISSIONDisplayToLogical(), writePERMISSIONGet(), writePERMISSIONIsValid(), writePERMISSIONLogicalToDisplay(), writePERMISSIONLogicalToOdbc(), writePERMISSIONLogicalToXSD(), writePERMISSIONNormalize(), writePERMISSIONSet(), writePERMISSIONXSDToLogical()

Methods (Including Private)

method %OnAfterCreatePage() as %Status [ Language = objectscript ]
Inherited description: Subclass to override. Always include code in this method.
method %OnGetPageName() as %String [ Language = objectscript ]
Get the (localized) name of the page. This should be implemented in a subclass.
classmethod Delete(FILETYPE) as %String [ Language = objectscript, ZenMethod ]
Delete selected routines now.
method DrawTableHeader(pSeed As %String) as %Status [ Language = objectscript ]
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 [ Language = objectscript ]
Method for executing the mapping query.
method GetLastSearch() as %String [ Language = objectscript ]
method OnDrawRibbon() as %Status [ Language = objectscript ]
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 [ Language = objectscript ]
Get information to display in the ribbon bar.
clientmethod changePage(newPage) [ Language = javascript ]
User clicked Routines or Globals to change page.
clientmethod codeClicked() [ Language = javascript ]
this method is called when user clicked the "Code" link. The value could not be passed with the correct escaping so we have to use the table value here.
clientmethod doCompare() [ Language = javascript ]
if user has selected some routines, pick the first two and pass to the Compare page.
clientmethod doCompile() [ Language = javascript ]
clientmethod doDelete() [ Language = javascript ]
clientmethod doDoc(routineName) [ Language = javascript ]
clientmethod doExport() [ Language = javascript ]
clientmethod doFind(isReplace) [ Language = javascript ]
Open up the Find/Replace CSP page.
clientmethod doFullView(routineName) [ Language = javascript ]
clientmethod doImport() [ Language = javascript ]
clientmethod doMask(nametype) [ Language = javascript ]
User clicked one of the routine name type.
clientmethod doNamespace(selTypeChanged) [ Language = javascript ]
Changed Nemespace <==> Database (implied namespace).
clientmethod doSearch() [ Language = javascript ]
User clicked Go to start search.
clientmethod doSelectRow(routineName) [ Language = javascript ]
clientmethod getSelectedNamespace() [ Language = javascript ]
return true namespace value or implied namespace value.
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 updatePreference() [ Language = javascript ]
clientmethod updateView() [ Language = javascript ]
Update / Reload table. This overrides the one in Template.List.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)