%CSP.UI.System.ExpListPane
class %CSP.UI.System.ExpListPane extends %CSP.Util.TablePane
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.Generic Pane for Displaying Explorer List.
Method Inventory (Including Private)
- CreateResultSet()
- DrawBODY()
- ExecuteResultSet()
- GetDescriptiveText()
- GetExpParameters()
- GetPageType()
- MaxRowsUpdate()
- OnDrawFilter()
- TypeDefault()
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 [ Language = objectscript ]
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...
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 [ Language = objectscript ]
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 [ Language = objectscript ]
This method performs the actual execution of the ResultSet
This can be overridden by subclasses
method GetDescriptiveText() [ Language = objectscript ]
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) [ Language = objectscript ]
Get Explorer Parameters Saved
method GetPageType() as %String [ Language = objectscript ]
This method returns the page type based on PageName
classmethod MaxRowsUpdate(MaxRows As %Integer) [ Language = objectscript ]
Called from client to update MaxRows
method OnDrawFilter(pInstance As %CSP.Util.PageInstance) as %Status [ Language = objectscript ]
This callback draws the search mask within the filter box.
classmethod TypeDefault() as %String [ Language = objectscript ]
Return pattern default for each type
Inherited Members
Inherited Properties (Including Private)
- Actions
- Align
- AutoRefresh
- CheckboxId
- CommandFormClass
- CommandFormObject
- CommandSubmitPage
- Commands
- Conditions
- FrameStyle
- HiddenColumns
- ItemsPerPage
- MaxColumns
- MaxResults
- Name
- Query
- SQLQuery
- ShowCheckboxes
- ShowFilter
- ShowLastUpdate
- ShowRowNumbers
- ShowSearchPage
- ShowZebra
- Sortable
- Styles
- Text
- URL
- bgcolor
- border
- cellpadding
- cellspacing
- enableAutoRefresh
Inherited Methods (Including Private)
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %ConstructCloneInit()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OnAddToSaveSet()
- %OnClose()
- %OnConstructClone()
- %OnNew()
- %OnValidateObject()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- CreateDataSet()
- CreateTempFile()
- DrawCommandForm()
- DrawCommands()
- DrawHEAD()
- DrawLastUpdate()
- DrawSearch()
- DrawStatusError()
- DrawTable()
- FilterTable()
- GenerateCode()
- GetItemsPerPage()
- ItemsPerPageUpdate()
- LocalizeColumnName()
- LocalizeText()
- OnDrawHEADTablePane()
- OnGenerateCode()
- PurgeTempData()
- QuoteCOS()
- RefreshTable()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLImportAttributes()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()