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

class %CSP.UI.Portal.Sharding.Dialog.TableDetails extends %CSP.Portal.standardDialog, %CSP.UI.Portal.Sharding.Utils

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
6 3 6


Summary

This is a Zen Page class. It belongs to the application %CSP.UI.Portal.Application.

Properties
%condition %import %includeFiles %page
%resource FirstFailed InvalidParam IsEMSReadOnly
MASTERNAMESPACE SHARDKEY TABLENAME ValidationErrorMsg
align aux backgroundTimerInterval cellAlign
cellSize cellStyle cellVAlign children
composite containerStyle cssLevel dialogTitle
disabled disabledStyle dragAndDrop dragEnabled
dropEnabled enclosingClass enclosingStyle error
groupClass groupStyle height hidden
hideApplyButton hideCancelButton hint hintClass
hintStyle iTimeoutInterval id index
label labelClass labelDisabledClass labelPosition
labelStyle layout msgWait name
onafterdrag onbeforedrag onclick ondrag
ondrop onhide onrefresh onshow
onupdate parent showLabel slice
title tuple useSVG useSoftModals
valign visible width window
zenPersistentPopup

Methods
%AddChild %AddChildAfter %AddChildBefore %AddComponent
%AddImportedComponents %AddToSaveSet %ApplyURLParms %Attr
%BindExport %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %DrawAutoLogout
%DrawClassDefinitions %DrawComponentHTML %DrawHTML %DrawHTMLPage
%DrawJSStrings %DrawObjectDefinitions %DrawTitle %EnclosingDivId
%EndBackgroundMethod %EndScript %Eval %EvalC
%Extends %ForceClientRender %GetChildIndex %GetComponent
%GetComponentById %GetComponentByName %GetEventHandlers %GetLinks
%GetPageName %GetParameter %GetValueById %GetValueByName
%GetXMLName %IsA %IsModified %Link
%LinkCSS %LinkScript %MakeId %New
%NormalizeObject %ObjectModified %OnAddToPageAfter %OnAddToPageBefore
%OnAfterCreatePage %OnBeforeCreatePage %OnCreateApplication %OnCreatePage
%OnDetermineCSSLevel %OnDrawEnclosingDiv %OnDrawHTMLBody %OnDrawHTMLHead
%OnDrawHTMLMeta %OnDrawObjectProperties %OnFinishBackgroundTask %OnGetSubtitle
%OnGetTitle %OnMonitorBackgroundTask %OnMutateChildren %OnObjectSynch
%OnPreHTTP %OnSubmit %OnUseSoftModals %OnZENDeserialize
%OriginalNamespace %PackageName %QuoteValue %QuoteValueL10N
%RemoveChild %RemoveChildren %RemoveComponent %RemoveFromSaveSet
%RunBackgroundMethod %Self %SerializeObject %SetBackgroundMethodStatus
%SetErrorById %SetErrorByName %SetModified %SetValueById
%SetValueByName %SetValuesByName %StartScript %ValidateObject
%ZENVersion CheckJobStatus ConvertParameter Decrypt
DrawAbortError Encrypt EscapeHTML EscapeURL
EvalResult GetNamespaceLists GetShardList HyperEventCall
HyperEventHead Include InsertHiddenField InsertHiddenFields
IsPrivate IsShardingEnabled JavaInstalled Link
OnHTTPHeader OnPage OnPageError OnPostHTTP
OnPostHyperEvent OnPreHTTP OnPreHyperEvent Page
QuoteJS RewriteURL ShowError StartTimer
StopTimer ThrowError UnescapeHTML UnescapeURL
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
addChild addChildAfter addChildBefore adjustSize
btnApply btnOK cancelPopup childrenMutated
correctIELayering createComponent createComponentNS ctrlKeyDown
deleteComponent dialogApply dialogCancel dialogFinish
dialogTitleGet disableButtons dragFinishHandler dragHandler
dragNotifyHandler dragStartHandler dropHandler dropStartHandler
endModal exposeComponent findElement fireOnResizeEvent
fireOnUnloadEvent fireOnUpdateEvent firePopupAction getChildIndex
getComponent getComponentById getDialogValue getEnclosingDiv
getHidden getHintElement getLabelElement getOpener
getProperty getSettings getType gotoPage
invokeSuper isOfType launchPopupWindow makeId
onCreate onDelete onDisplayHandler onEndModalHandler
onPopupAction onRefreshContents onSerialize onServerMethodCall
onServerMethodError onServerMethodReturn onStartModalHandler ondialogCancel
ondialogFinish ondialogStart ondisabledHandler onhandleAutoLogoutWarn
onkeydownHandler onkeyupHandler onlayoutHandler onloadHandler
onlogoutHandler onoverlayHandler onresizeHandler onunloadHandler
onupdateHandler popupActionHandler refreshContents removeChild
render renderContents renderSVG resetMsg
setComponentId setHidden setOverlayMode setProperty
setPropertyAll setTraceOption showMsg startModal
startProgressBar stopProgressBar validateRequired


Parameters

• parameter APPLICATION = "%CSP.UI.Portal.Application";
This is the class name of this application this page belongs to. If not defined, this page does not belong to an application.
• parameter APPLYBUTTON = 0;
If true, then this dialog displays an Apply button.
• parameter CANCELBUTTON = 0;
If true, then this dialog displays a Cancel button.
• parameter CSPURL = "/csp/sys/mgr/%CSP.UI.Portal.Sharding.Dialog.TableDetails.zen";
This parameter is used to make sure that if multiple CSP applications are mapped to the same namespace that the CSP engine can correctly identify which class corresponds with which URL. If 'LockCSPName' is true (the default, defined in the CSP application) then you can only access this page if the url exactly matches this 'CSPURL'. You can set this parameter to "" if you wish to disable this check for this class. This check is applied for all CSP urls (cls/csp/zen).
If this page was compiled from a .csp file, then this parameter is automatically set to contain the url of this file used for compilation.
• parameter PAGENAME = "ShardingTableDetails";
Displayed name of this page.
• parameter RESOURCE = "%Admin_Manage";
This is a comma-delimited list of system Resources and associated permissions. A user must hold the specified permissions on at least one of the specified resources in order to view this page or invoke any of its server-side methods from the client.
The format of each item in the list should be as follows:
Resource[:Permission]
Permission is optional, and defaults to USE if not supplied. If it is supplied, it should be one of USE, READ or WRITE.

Properties

• property MASTERNAMESPACE as %String(ZENURL="MASTERNAMESPACE");
• property SHARDKEY as %String(ZENURL="SHARDKEY");
• property TABLENAME as %String(ZENURL="TABLENAME");

Methods

• method %OnAfterCreatePage() as %Status
Be sure to do ##super() when overriding.
• method %OnGetSubtitle() as %String
Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.
• method %OnGetTitle() as %String
Get the (localized) title string for the dialog. This should be implemented in a subclass.
• method DrawAbortError(seed As %String) as %Status
• method getDialogValue() [ Language = javascript ]
Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.


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