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

class %DeepSee.UI.Dialog.FormatString extends %DeepSee.UI.Dialog.standardDialog

This dialog lets the user edit or add Format String for measure definition.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 4 8


Summary

This is a Zen Page class. 

Properties
%condition %import %includeFiles %page
%resource FirstFailed InvalidParam IsEMSReadOnly
ValidationErrorMsg align aux backgroundTimerInterval
cellAlign cellSize cellStyle cellVAlign
children composite containerStyle cssLevel
cubeName dialogTitle disabled disabledStyle
dragAndDrop dragEnabled dropEnabled enclosingClass
enclosingStyle error formatString groupClass
groupStyle height hidden hideApplyButton
hideCancelButton hint hintClass hintStyle
id index label labelClass
labelDisabledClass labelPosition labelStyle layout
measureName msgCube 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 ConvertParameter Decrypt Encrypt
EscapeHTML EscapeURL EvalResult GetDisplayValue
HyperEventCall HyperEventHead Include InsertHiddenField
InsertHiddenFields IsPrivate 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 showExample showMsg
showStyle startModal startProgressBar stopProgressBar
stripWhitespaces validateRequired


Parameters

• parameter APPLYBUTTON = 0;
If true, then this dialog displays an Apply button.

Properties

• property cubeName as %ZEN.Datatype.string(ZENURL="CUBE");
Cube name.
• property formatString as %ZEN.Datatype.string(ZENURL="VALUE");
• property measureName as %ZEN.Datatype.string(ZENURL="ELEMENT");
• property msgCube as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Please enter a Cube Name.") ];

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.
• classmethod GetDisplayValue(format As %String) as %String [ ZenMethod ]
Return example display value given user entered format string.
• method getDialogValue() [ Language = javascript ]
Value returned is delimited first by "^" then by ";". The first piece of "^" is the String value, the second piece is the Color value.
The String values and Color values are each delimited by ";".
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method showExample(value, id) as %Boolean [ Language = javascript ]
Apply a format string value to the associated example
• method showStyle(value, id) as %Boolean [ Language = javascript ]
Apply a style value to the associated example


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