This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?

%CSP.UI.System.ExpListPane

class %CSP.UI.System.ExpListPane extends %CSP.Util.TablePane

This class is used internally by Caché. 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.

Generic Pane for Displaying Explorer List.

Method Inventory

Parameters

parameter HIDEFILTERWHENEMPTY = 0;
Inherited description: Do not display filter box when there are no results

Methods

method CreateResultSet(ByRef pID As %String, ByRef pRS As %ResultSet) as %Status
This method creates the %ResultSet object that is used for the table pane.
A subclass can override this to customize the table displayed by this pane.
pID is array of page variables...
method DrawBODY(pInstance As %CSP.Util.PageInstance) as %Status
Draw the BODY of the detail pane The only difference is the comment at the end for legacy backup routines.
method ExecuteResultSet(pRS As %ResultSet, ByRef pID As %String) as %Status
This method performs the actual execution of the ResultSet This can be overridden by subclasses
method GetDescriptiveText()
Return (localized) text message displayed near top of page. Ignore value in CSP file
classmethod GetExpParameters(ByRef Type As %String, ByRef MaxResults As %Integer, ByRef Spec As %String, ByRef OrderBy As %Integer, ByRef Dir As %Integer)
Get Explorer Parameters Saved
method GetPageType() as %String
This method returns the page type based on PageName
classmethod MaxRowsUpdate(MaxRows As %Integer)
Called from client to update MaxRows
method OnDrawFilter(pInstance As %CSP.Util.PageInstance) as %Status
This callback draws the search mask within the filter box.
classmethod TypeDefault() as %String
Return pattern default for each type

Inherited Members

Inherited Properties

Inherited Methods

Subclasses

Feedback