Class Reference
%CSP.UI.System.ExpListPane
Server:basexml
Instance:SOAXML
User:UnknownUser
 
-
  [BASEXML] >  [%CSP] >  [UI] >  [System] >  [ExpListPane]
Private  Storage

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.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 9


Summary

Properties
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

Methods
%%OIDGet %AddToSaveSet %ClassIsLatestVersion %ClassName
%ConstructClone %DispatchClassMethod %DispatchGetModified %DispatchGetProperty
%DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty
%Extends %GetParameter %IsA %IsModified
%New %NormalizeObject %ObjectModified %OriginalNamespace
%PackageName %RemoveFromSaveSet %SerializeObject %SetModified
%ValidateObject CreateDataSet CreateResultSet CreateTempFile
DrawBODY DrawCommandForm DrawCommands DrawHEAD
DrawLastUpdate DrawSearch DrawStatusError DrawTable
ExecuteResultSet FilterTable GenerateCode GetDescriptiveText
GetExpParameters GetItemsPerPage GetPageType ItemsPerPageUpdate
LocalizeColumnName LocalizeText MaxRowsUpdate OnDrawFilter
OnDrawHEADTablePane OnGenerateCode PurgeTempData QuoteCOS
RefreshTable TypeDefault XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType

Subclasses
%CSP.UI.System.GlobalListPane

Parameters

• parameter HIDEFILTERWHENEMPTY = 0;
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