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

%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)

Parameters

parameter COLUMNDOMAIN = %UtilityColumns;
Default localization domain used for column headers
parameter COLUMNHELPDOMAIN = %UtilityColumnHelp;
Default localization domain used for column headers help messages
parameter HIDEFILTERWHENEMPTY = 1;
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(), ShowLast