DocBook|Search
Class Reference
%CSP.UI.SQL.SQLPane
   
Server:basexml
Instance:SOAXML
User:UnknownUser
 
-
  [BASEXML] >  [%CSP] >  [UI] >  [SQL] >  [SQLPane]
Private  Storage  

class %CSP.UI.SQL.SQLPane 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. This class is used for SQL Manager utilities

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
7 5


Summary

Properties
Actions Align CommandFormClass CommandFormObject
CommandSubmitPage Commands FrameStyle MaxColumns
Method Name Query ShowRowNumbers
ShowZebra Sortable Styles Text
URL

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 BuildSortFile DrawBODY DrawCommandForm
DrawCommands DrawHEAD GenerateCode LocalizeText
OnGenerateCode QuoteCOS TuneTables XMLDTD
XMLExport XMLExportToStream XMLExportToString XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType listCQ


Properties

• 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 MaxColumns as %Integer;
Max number of columns to show.
• property Method as %String(MAXLEN=128);
Name of the class method that provides info for the Cached Query.
This is a full name: e.g., "Package.Class:MethodName" In this SYSTEM class the Method is used to store the function name
• 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" In this SYSTEM class the Query is used to store the function name
• property ShowRowNumbers as %Boolean [ InitialExpression = 0 ];
If true, then rows numbers are displayed.
• property ShowZebra as %Boolean [ InitialExpression = 0 ];
If true, then rows are displayed using zebra styling.
• property Sortable as %Boolean [ InitialExpression = 0 ];
If true, then rows in the table can be sorted.

Methods

• classmethod BuildSortFile(pRS As %ResultSet, pSortCol As %String, pMaxCols As %Integer, ByRef pCols As %String, ByRef pSortFile) as %Boolean
Sort the data within a ResultSet and place the results in a tempfile. pCol contains the names of the columns ordered by column #.
• method DrawBODY(pInstance As PageInstance) as %Status
Draw the BODY of the detail pane
• method OnGenerateCode() as %String
Subclasses override this to generate code during CSP processing
• classmethod TuneTables(ByRef pParms As %String) as %Status
Method to tune all tables in a schema in the background
• classmethod listCQ(ByRef listRec As %String, ByRef listTH As %String, ByRef tQuery As %String) as %Integer
Return CQ infor