This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see the InterSystems IRIS Migration Guide and Migrating to InterSystems IRIS, both available on the WRC Distributions page (login required).

%CSP.Util.SMNavigatorPane

class %CSP.Util.SMNavigatorPane 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.

Navigator Pane for System Managment Portal.

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties

property ShowDatabases as %Boolean [ InitialExpression = 0 ];
If 1, then namespace listbox allows choice of databases as well.
Property methods: ShowDatabasesDisplayToLogical(), ShowDatabasesGet(), ShowDatabasesIsValid(), ShowDatabasesLogicalToDisplay(), ShowDatabasesLogicalToXSD(), ShowDatabasesNormalize(), ShowDatabasesSet(), ShowDatabasesXSDToLogical()
property ShowMaxRows as %Boolean [ InitialExpression = 0 ];
If true, then the max rows textbox is display.
Property methods: ShowMaxRowsDisplayToLogical(), ShowMaxRowsGet(), ShowMaxRowsIsValid(), ShowMaxRowsLogicalToDisplay(), ShowMaxRowsLogicalToXSD(), ShowMaxRowsNormalize(), ShowMaxRowsSet(), ShowMaxRowsXSDToLogical()
property ShowNamespaces as %Boolean;
If 1, then namespace listbox displays. If 0, then namespace name displays.
Property methods: ShowNamespacesDisplayToLogical(), ShowNamespacesGet(), ShowNamespacesIsValid(), ShowNamespacesLogicalToDisplay(), ShowNamespacesLogicalToXSD(), ShowNamespacesNormalize(), ShowNamespacesSet(), ShowNamespacesXSDToLogical()
property ShowSchemas as %Boolean [ InitialExpression = 0 ];
If true, then schema listbox is display.
Property methods: ShowSchemasDisplayToLogical(), ShowSchemasGet(), ShowSchemasIsValid(), ShowSchemasLogicalToDisplay(), ShowSchemasLogicalToXSD(), ShowSchemasNormalize(), ShowSchemasSet(), ShowSchemasXSDToLogical()
property bgcolor as %String (TRUNCATE = 1);
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

method DrawBODY(pInstance As PageInstance) as %Status
Inherited description: Overwritten by subclasses to draw anything this pane needs for the BODY section.
method DrawHEAD(pInstance As PageInstance) as %Status
Overwritten by subclasses to draw anything this pane needs for the HEAD section.
classmethod GetAllDatabases(ByRef Databases As %String) as %Integer
Generic method to get databases Databases array is returned by reference.
Remote databases are included
classmethod GetAllNamespaces(ByRef Namespaces As %String) as %Integer
Generic method to get namespaces from the ACTIVE Configuration file.
Namespace array is returned by reference.
classmethod GetNamespaces(ByRef Namespaces As %String) as %Integer
Generic method to get namespaces from the ACTIVE Configuration file. Namespace array is returned by reference. Returns array of namespaces the user has Read or Write privileges in.
classmethod GetSchemas(ByRef Schemas As %String) as %Integer
Generic method to get Schemas for the current namespace. Namespace array is returned by reference.
method OnGenerateCode() as %String
Inherited description: Subclasses override this to generate code during CSP processing

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Feedback