Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%CSP] >  [UI] >  [SQL] >  [BrowseTablePane]
Private  Storage   

class %CSP.UI.SQL.BrowseTablePane extends %CSP.Util.TablePane

Customized TablePane for browsing SQL tables. Added textbox to allow user to enter maximum number of rows to load for Open Table

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 7


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 enableAutoRefresh

Methods
%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 GetItemsPerPage
GetOpenTableMaxRows GetPageType GetSearchMask ItemsPerPageUpdate
LocalizeColumnName LocalizeText OnDrawFilter OnDrawHEADTablePane
OnGenerateCode OpenTableMaxRowsUpdate PurgeTempData QuoteCOS
RefreshTable XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType


Parameters

• parameter HIDEFILTERWHENEMPTY = 0;
display filter box when there are no results so that user can adjust their mask for tables.

Methods

• method DrawBODY(pInstance As %CSP.Util.PageInstance) as %Status
Draw the BODY of the detail pane
• method ExecuteResultSet(pRS As %ResultSet, ByRef pID As %String) as %Status
This method performs the actual execution of the ResultSet pID(3) is the searchMask from user clicking the "Go" rather than user clicking a schema which sets $ID(2). If it is from Go then it is possible user removed the mask then default to "*". Otherwise retain the last mask.
• classmethod GetOpenTableMaxRows() as %Integer
Returns default OpenTableMaxRows value.
• method GetPageType() as %String
This method returns the page type based on PageName
• classmethod GetSearchMask() as %String
Generic Method being called from the Routine panes to return search mask.
• method OnDrawFilter(pInstance As %CSP.Util.PageInstance) as %Status
This callback draws the search mask within the filter box.
• classmethod OpenTableMaxRowsUpdate(OpenTableMaxRows As %Integer)
Called from client to update OpenTableMaxRows


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.