This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > %CSP.Util.TablePane


class %CSP.Util.TablePane extends %CSP.Util.Pane

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.

An AutoPage pane that displays a table based on a class query.

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter COLUMNDOMAIN = %UtilityColumns;
Default localization domain used for column headers
parameter COLUMNHELPDOMAIN = %UtilityColumnHelp;
Default localization domain used for column headers help messages
Do not display filter box when there are no results
parameter RefreshRate = 11000;
Default refresh rate (in milliseconds)
parameter SHOWSEARCHFORM = 0;
Show advanced search form
parameter SHOWSQLINFO = 0;
Should this page display SQL Info
parameter SHOWSTATISTICS = 0;
Should this page display timing stats
parameter WrapLimit = 40;
Default wrap limit

Properties (Including Private)

property Actions as array of %CSP.Util.Action (XMLKEYNAME = "name");
An array of actions, indexed by column name in the query. These are associated with columns in a table.
If the subscript name starts with a $, then the action is displayed as an additional column in the table.
Property methods: ActionsBuildValueArray(), ActionsCollectionToDisplay(), ActionsCollectionToOdbc(), ActionsDisplayToCollection(), ActionsGet(), ActionsGetObject(), ActionsGetObjectId(), ActionsGetSwizzled(), ActionsIsValid(), ActionsOdbcToCollection(), ActionsSet(), ActionsSetObject(), ActionsSetObjectId()
property AutoRefresh as %Boolean [ InitialExpression = 0 ];
If true, then this table is automatically updated.
Property methods: AutoRefreshDisplayToLogical(), AutoRefreshGet(), AutoRefreshIsValid(), AutoRefreshLogicalToDisplay(), AutoRefreshLogicalToXSD(), AutoRefreshNormalize(), AutoRefreshSet(), AutoRefreshXSDToLogical()
property CheckboxId as %String (MAXLEN = 128);
If set, name of column that provides unique id values for checkboxes.
Property methods: CheckboxIdDisplayToLogical(), CheckboxIdGet(), CheckboxIdIsValid(), CheckboxIdLogicalToDisplay(), CheckboxIdLogicalToOdbc(), CheckboxIdNormalize(), CheckboxIdSet()
property Conditions as list of %CSP.Util.Condition;
A list of conditions; these are expressions that are evaluated to add custom colors to the table
Property methods: ConditionsBuildValueArray(), ConditionsCollectionToDisplay(), ConditionsCollectionToOdbc(), ConditionsDisplayToCollection(), ConditionsGet(), ConditionsGetObject(), ConditionsGetObjectId(), ConditionsGetSwizzled(), ConditionsIsValid(), ConditionsOdbcToCollection(), ConditionsSet(), ConditionsSetObject(), ConditionsSetObjectId()
property HiddenColumns as %String (MAXLEN = 500);
Comma-separated list of columns that should not be displayed.
Property methods: HiddenColumnsDisplayToLogical(), HiddenColumnsGet(), HiddenColumnsIsValid(), HiddenColumnsLogicalToDisplay(), HiddenColumnsLogicalToOdbc(), HiddenColumnsNormalize(), HiddenColumnsSet()
property ItemsPerPage as %Integer [ InitialExpression = 20 ];
Number of items to show per page.
Property methods: ItemsPerPageDisplayToLogical(), ItemsPerPageGet(), ItemsPerPageIsValid(), ItemsPerPageLogicalToDisplay(), ItemsPerPageNormalize(), ItemsPerPageSet(), ItemsPerPageUpdate(), ItemsPerPageXSDToLogical()
property MaxColumns as %Integer;
Max number of columns to show. (deprecated)
Property methods: MaxColumnsDisplayToLogical(), MaxColumnsGet(), MaxColumnsIsValid(), MaxColumnsLogicalToDisplay(), MaxColumnsNormalize(), MaxColumnsSet(), MaxColumnsXSDToLogical()
property MaxResults as %Integer [ InitialExpression = 10000 ];
Max number of results to find.
Property methods: MaxResultsDisplayToLogical(), MaxResultsGet(), MaxResultsIsValid(), MaxResultsLogicalToDisplay(), MaxResultsNormalize(), MaxResultsSet(), MaxResultsXSDToLogical()
property Query as %String (MAXLEN = 128);
Name of the class query that provides info for the Table.
This is a full name: e.g., "Package.Class:QueryName"
Property methods: QueryDisplayToLogical(), QueryGet(), QueryIsValid(), QueryLogicalToDisplay(), QueryLogicalToOdbc(), QueryNormalize(), QuerySet()
property SQLQuery as %String (MAXLEN = 512);
Optional SQL query for this table.
If present, supercedes the value in Query.
Property methods: SQLQueryDisplayToLogical(), SQLQueryGet(), SQLQueryIsValid(), SQLQueryLogicalToDisplay(), SQLQueryLogicalToOdbc(), SQLQueryNormalize(), SQLQuerySet()
property ShowCheckboxes as %Boolean [ InitialExpression = 0 ];
If true, then checkboxes are displayed with each row.
Property methods: ShowCheckboxesDisplayToLogical(), ShowCheckboxesGet(), ShowCheckboxesIsValid(), ShowCheckboxesLogicalToDisplay(), ShowCheckboxesLogicalToXSD(), ShowCheckboxesNormalize(), ShowCheckboxesSet(), ShowCheckboxesXSDToLogical()
property ShowFilter as %Boolean [ InitialExpression = 1 ];
If true, then display the Filter box.
Property methods: ShowFilterDisplayToLogical(), ShowFilterGet(), ShowFilterIsValid(), ShowFilterLogicalToDisplay(), ShowFilterLogicalToXSD(), ShowFilterNormalize(), ShowFilterSet(), ShowFilterXSDToLogical()
property ShowLastUpdate as %Boolean [ InitialExpression = 1 ];
Show Last Update box (if set to 0 then do not show last update box)
Property methods: ShowLastUpdateDisplayToLogical(), ShowLastUpdateGet(), ShowLastUpdateIsValid(), ShowLastUpdateLogicalToDisplay(), ShowLastUpdateLogicalToXSD(), ShowLastUpdateNormalize(), ShowLastUpdateSet(), ShowLastUpdateXSDToLogical()
property ShowRowNumbers as %Boolean [ InitialExpression = 0 ];
If true, then rows numbers are displayed.
Property methods: ShowRowNumbersDisplayToLogical(), ShowRowNumbersGet(), ShowRowNumbersIsValid(), ShowRowNumbersLogicalToDisplay(), ShowRowNumbersLogicalToXSD(), ShowRowNumbersNormalize(), ShowRowNumbersSet(), ShowRowNumbersXSDToLogical()
property ShowSearchPage as %Boolean;
Show Advanced search page (deprecated)
Property methods: ShowSearchPageDisplayToLogical(), ShowSearchPageGet(), ShowSearchPageIsValid(), ShowSearchPageLogicalToDisplay(), ShowSearchPageLogicalToXSD(), ShowSearchPageNormalize(), ShowSearchPageSet(), ShowSearchPageXSDToLogical()
property ShowZebra as %Boolean [ InitialExpression = 0 ];
If true, then rows are displayed using zebra styling.
Property methods: ShowZebraDisplayToLogical(), ShowZebraGet(), ShowZebraIsValid(), ShowZebraLogicalToDisplay(), ShowZebraLogicalToXSD(), ShowZebraNormalize(), ShowZebraSet(), ShowZebraXSDToLogical()
property Sortable as %Boolean [ InitialExpression = 1 ];
If true, then rows in the table can be sorted.
Property methods: SortableDisplayToLogical(), SortableGet(), SortableIsValid(), SortableLogicalToDisplay(), SortableLogicalToXSD(), SortableNormalize(), SortableSet(), SortableXSDToLogical()
property bgcolor as %String (MAXLEN = 50);
Table background color
Property methods: bgcolorDisplayToLogical(), bgcolorGet(), bgcolorIsValid(), bgcolorLogicalToDisplay(), bgcolorLogicalToOdbc(), bgcolorNormalize(), bgcolorSet()
property border as %Integer;
Border of table (default is 0)
Property methods: borderDisplayToLogical(), borderGet(), borderIsValid(), borderLogicalToDisplay(), borderNormalize(), borderSet(), borderXSDToLogical()
property cellpadding as %Integer;
Cellpadding (default is 0)
Property methods: cellpaddingDisplayToLogical(), cellpaddingGet(), cellpaddingIsValid(), cellpaddingLogicalToDisplay(), cellpaddingNormalize(), cellpaddingSet(), cellpaddingXSDToLogical()
property cellspacing as %Integer;
Cellspacing (default is 0)
Property methods: cellspacingDisplayToLogical(), cellspacingGet(), cellspacingIsValid(), cellspacingLogicalToDisplay(), cellspacingNormalize(), cellspacingSet(), cellspacingXSDToLogical()

Methods (Including Private)

method CreateDataSet(ByRef pID As %String, pFileID As %String, pTempID As %String) as %Status
Runs the query and builds a temp file
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 CreateTempFile(pFileID As %String, pTempID As %String, ByRef pID As %String, pRS As %ResultSet) as %Status
Execute a result set and create a temp file
method DrawBODY(pInstance As %CSP.Util.PageInstance) as %Status
Draw the BODY of the detail pane
method DrawHEAD(pInstance As PageInstance) as %Status
Inherited description: Overwritten by subclasses to draw anything this pane needs for the HEAD section.
method DrawLastUpdate()
Show Last Update box
method DrawSearch(pInstance As %CSP.Util.PageInstance) as %Status
This callback is invoked when specific or advanced search criteria is being drawn to allow insert of additional UI elements at the end of table
classmethod DrawStatusError(tSC As %String)
Generic method to draw error message for object status code.
method DrawTable(pInstance As PageInstance, ByRef pID As %String, pFileID As %String, pTempID As %String, pPageNo As %Integer = 1, pSort As %String = "", pDirection As %Integer = 1, pFilter As %String = "", pCBState As %String = "", ByRef pFound As %String) as %Status
Generate JavaScript to draw the table Also updates paging buttons
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
classmethod FilterTable(pPageNo As %Integer, pTimeSlot As %Integer, pTempID As %String, pSort As %String, pDirection As %String, pFilter As %String, pPageClass As %String, pFrame As %String, pCBState As %String, pID1, pID2, pNS As %String)
Called from client to refilter the table
method GetDescriptiveText()
Return (localized) text message displayed near top of page. Subclasses may override this.
method GetItemsPerPage() as %Integer
Returns default items per page value.
classmethod ItemsPerPageUpdate(pPageSize As %Integer)
Called from client to update ItemsPerPage
classmethod LocalizeColumnName(pName As %String, Output pHelpMsg) as %String
Lookup a column name in the localization global and return localized version if present
method OnDrawFilter(pInstance As %CSP.Util.PageInstance) as %Status
This callback is invoked when the table filter is being drawn to allow insert of additional UI elements
method OnDrawHEADTablePane(pInstance As %CSP.Util.PageInstance) as %Status
method OnGenerateCode() as %String
Inherited description: Subclasses override this to generate code during CSP processing
classmethod PurgeTempData()
Purge all out-of-date temp data used by TablePane
classmethod RefreshTable(pPageNo As %Integer, pTimeSlot As %Integer, pTempID As %String, pSort As %String, pDirection As %String, pFilter As %String, pAuto As %Boolean, pPageClass As %String, pFrame As %String, pCBState As %String, pID1 As %String, pID2 As %String, pNS As %String, pRate As %Integer)
Called from client to refresh the table

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)