Class Reference
%DeepSee.UI.Dialog.PivotEditRule
Server:appadmin-00044-deployment-6bf4cbc86d-9f4xc
Instance:IRIS
User:SuperUser
 
-
  [USER] >  [%DeepSee] >  [UI] >  [Dialog] >  [PivotEditRule]
Private  Storage

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

This dialog adds (or edits) a new formatting rule definition to a DeepSee pivot.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 10 11


Summary

This is a Zen Page class. 

Properties
%condition %import %includeFiles %page
%resource FirstFailed InvalidParam IsEMSReadOnly
ValidationErrorMsg align aux backgroundTimerInterval
cellAlign cellIcon 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 icon
iconCount id index label
labelClass labelDisabledClass labelPosition labelStyle
layout name onafterdrag onbeforedrag
onclick ondrag ondrop onhide
onrefresh onshow onupdate operator
parent range ruleNumber sampleIcon
showLabel slice style text
title tuple useSVG useSoftModals
valign value 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 DrawCellIcons
Encrypt EscapeHTML EscapeURL EvalResult
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
clearRange 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 selectIcon setComponentId setHidden
setOverlayMode setProperty setPropertyAll setTraceOption
showMsg startModal startProgressBar stopProgressBar
stripWhitespaces updateOperator updateSample validateRequired


Parameters

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

Properties

• property cellIcon as %ZEN.Datatype.string(ZENURL="ICON");
Name of icon in effect. Names starting with "@" are user-defined names from the user icon list.
• property icon as %ZEN.Datatype.uri(ZENURL="ICON");
Icon.
• property iconCount as %ZEN.Datatype.integer(ZENURL="ICONCOUNT");
Icon count.
• property operator as %ZEN.Datatype.string(ZENURL="OPERATOR");
Condition operator.
• property range as %ZEN.Datatype.string(ZENURL="RANGE");
Range of cells for which this rule applies.
• property ruleNumber as %ZEN.Datatype.string(ZENURL="NUMBER");
Index of rule within parent dialog list or "" for new.
• property sampleIcon as %ZEN.Datatype.string;
Url of current icon.
• property style as %ZEN.Datatype.style(ZENURL="STYLE");
CSS style to apply to cells that match this condition.
• property text as %ZEN.Datatype.string(ZENURL="TEXT");
If defined, replace value with this text.
• property value as %ZEN.Datatype.csv(ZENURL="VALUE");
Value (or values) to test. For IN and BETWEEN this is a comma-delimited list.

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 DrawCellIcons(pSeed As %String) as %Status
Draw contents of cell icon box.
• method clearRange() [ Language = javascript ]
Click on clear range button.
• method getDialogValue() [ Language = javascript ]
Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.
• method ondialogFinish(action) as %Boolean [ Language = javascript ]
This callback, if defined, is called when the user presses the OK or Apply action buttons. If this returns false, then the action is cancelled.
• method ondialogStart() [ Language = javascript ]
This callback, if defined, is called when the dialog page is loaded.
• method selectIcon(type, href) [ Language = javascript ]
Click on a new cell icon.
• method updateOperator(type) [ Language = javascript ]
Click on a new operator value.
• method updateSample() [ Language = javascript ]
Update the sample.


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