Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [EnsPortal] >  [Component] >  [sqlParametersTable]
Private  Storage   

class EnsPortal.Component.sqlParametersTable extends %ZEN.Component.composite

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 10 17


Summary

Properties
%condition %import %includeFiles %page
%resource align aux cellAlign
cellSize cellStyle cellVAlign children
childrenCreated classSettingName composite containerClass
containerStyle currParam currParamNum disabled
dragEnabled dropEnabled enclosingClass enclosingStyle
error groupClass groupStyle height
hidden hint hintClass hintStyle
id inParamInfo index label
labelClass labelDisabledClass labelPosition labelStyle
layout name onafterdrag onbeforedrag
onclick ondrag ondrop onhide
onrefresh onshow onupdate params
parent prependAsterix query querySetting
readOnly showLabel slice title
tuple valign visible width
window

Methods
%AddChild %AddChildAfter %AddChildBefore %AddToSaveSet
%Attr %BindExport %ClassIsLatestVersion %ClassName
%ConstructClone %CreateComposite %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %DrawComponentHTML %DrawHTML %DrawJSStrings
%EnclosingDivId %Eval %EvalC %Extends
%ForceClientRender %GetChildById %GetChildIndex %GetEventHandlers
%GetPaneContents %GetParameter %GetXMLName %IsA
%IsModified %MakeId %New %NormalizeObject
%ObjectModified %OnAddToPageAfter %OnAddToPageBefore %OnAfterCreateComposite
%OnDrawEnclosingDiv %OnDrawObjectProperties %OnMutateChildren %OnObjectSynch
%OnSubmit %OnZENDeserialize %OriginalNamespace %PackageName
%QuoteValue %QuoteValueL10N %RemoveChild %RemoveChildren
%RemoveFromSaveSet %Self %SerializeObject %SetModified
%ValidateObject GetContents GetParamsToDisplay XMLDTD
XMLExport XMLExportToStream XMLExportToString XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType addChild
addChildAfter addChildBefore addParam childrenMutated
createChildren deleteParam dragFinishHandler dragHandler
dragNotifyHandler dragStartHandler dropHandler dropStartHandler
exposeComponent findElement fireOnUpdateEvent getChildById
getChildIndex getEnclosingDiv getForm getHidden
getHintElement getLabelElement getProperty getSettings
getType getValue invokeSuper isOfType
makeId onCreate onDelete onDisplayHandler
onEndModalHandler onPopupAction onRefreshContents onSerialize
onStartModalHandler ondisabledHandler onloadHandler onunloadHandler
onupdateHandler refreshContents refreshParams removeChild
render renderContents renderSVG saveParam
setCurrParam setHidden setModified setOverlayMode
setProperty setPropertyAll setValue showParamInfo
startProgressBar stopProgressBar switchCurrParam uiDeleteParam


Parameters

• parameter DOMAIN = "Ensemble";
• parameter USECOMMONDIRECTORY = 1;
If true, then the include files generated for this component, are placed in the common /csp/broker directory and not the local /csp/*namespace* directory.
This is intended for use with packages that are mapped so as to be visible to every namespace.
All Zen classes within the same package must have the same value for this parameter. It is the developer's responsibility to ensure this.

Properties

• property classSettingName as %String;
• property containerClass as %String;
• property currParam as %String;
• property currParamNum as %Integer [ InitialExpression = 0 ];
• property inParamInfo as %Boolean [ InitialExpression = 0 ];
• property params as %String(MAXLEN="");
• property prependAsterix as %Integer [ InitialExpression = 0 ];
• property query as %String;
• property querySetting as %String;
• property readOnly as %ZEN.Datatype.boolean [ InitialExpression = 0 ];

Methods

• method GetContents() as %String [ ZenMethod ]
Get the contents of the Parameters table
• classmethod GetParamsToDisplay(pParams="") as %String [ ZenMethod ]
• method addParam() [ Language = javascript ]
• method createChildren(form) [ Language = javascript ]
Create children on client side so we can use them immediately. Note that the server may substitute fresh code-generated objects later.
• method deleteParam(pNumber) as %Boolean [ ZenMethod ]
• method getForm() [ Language = javascript ]
• method getProperty(property, key) as %String [ Language = javascript ]
Return the value of a named property (i.e. a setting).
Returns null if this is not a property of this object.
key is an optional argument used for properties (such as collections) that may need a key to find a specific value.
• final method getValue() [ Language = javascript ]
• method refreshParams() [ Language = javascript ]
Refresh the table which displays the Parameters to use
• method saveParam(pNumber As %Integer, pValue As %String = "") as %Boolean [ ZenMethod ]
• method setCurrParam(switchTo) [ Language = javascript ]
Set a particular parameter to be editable
• method setModified() [ Language = javascript ]
Call on Production Config page's settingChanged() so that it recognizes this change
• method setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.
Assume that subclasses that simply wrap HTML controls have named the control 'control' or else have overridden this method.
• final method setValue(value, value2) [ Language = javascript ]
Client-side method to set the value associated with this control. value2 is an optional, second parameter used by some controls (such as dataCombo).
• method showParamInfo(param, paramnum) [ Language = javascript ]
User clicked the Browse button. Helper method to wrap the main helper popup() function in the containing page (Production Config).
• method switchCurrParam(switchTo, value) [ Language = javascript ]
If there is a parameter being edited, save that first before making another parameter editable Then set the new parameter to be editable
• method uiDeleteParam(paramNum, id) [ Language = javascript ]


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