Skip to main content


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

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

Property Inventory

Method Inventory


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


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 methods: cellIconDisplayToLogical(), cellIconGet(), cellIconIsValid(), cellIconLogicalToDisplay(), cellIconLogicalToOdbc(), cellIconNormalize(), cellIconSet()
property icon as %ZEN.Datatype.uri (ZENURL = "ICON");
Property methods: iconDisplayToLogical(), iconGet(), iconIsValid(), iconLogicalToDisplay(), iconLogicalToOdbc(), iconNormalize(), iconSet()
property iconCount as %ZEN.Datatype.integer (ZENURL = "ICONCOUNT");
Icon count.
Property methods: iconCountDisplayToLogical(), iconCountGet(), iconCountIsValid(), iconCountLogicalToDisplay(), iconCountLogicalToOdbc(), iconCountNormalize(), iconCountSet()
property operator as %ZEN.Datatype.string (ZENURL = "OPERATOR");
Condition operator.
Property methods: operatorDisplayToLogical(), operatorGet(), operatorIsValid(), operatorLogicalToDisplay(), operatorLogicalToOdbc(), operatorNormalize(), operatorSet()
property range as %ZEN.Datatype.string (ZENURL = "RANGE");
Range of cells for which this rule applies.
Property methods: rangeDisplayToLogical(), rangeGet(), rangeIsValid(), rangeLogicalToDisplay(), rangeLogicalToOdbc(), rangeNormalize(), rangeSet()
property ruleNumber as %ZEN.Datatype.string (ZENURL = "NUMBER");
Index of rule within parent dialog list or "" for new.
Property methods: ruleNumberDisplayToLogical(), ruleNumberGet(), ruleNumberIsValid(), ruleNumberLogicalToDisplay(), ruleNumberLogicalToOdbc(), ruleNumberNormalize(), ruleNumberSet()
property sampleIcon as %ZEN.Datatype.string;
Url of current icon.
Property methods: sampleIconDisplayToLogical(), sampleIconGet(), sampleIconIsValid(), sampleIconLogicalToDisplay(), sampleIconLogicalToOdbc(), sampleIconNormalize(), sampleIconSet()
property style as (ZENURL = "STYLE");
CSS style to apply to cells that match this condition.
Property methods: styleDisplayToLogical(), styleGet(), styleIsValid(), styleLogicalToDisplay(), styleLogicalToOdbc(), styleNormalize(), styleSet()
property text as %ZEN.Datatype.string (ZENURL = "TEXT");
If defined, replace value with this text.
Property methods: textDisplayToLogical(), textGet(), textIsValid(), textLogicalToDisplay(), textLogicalToOdbc(), textNormalize(), textSet()
property value as %ZEN.Datatype.csv (ZENURL = "VALUE");
Value (or values) to test. For IN and BETWEEN this is a comma-delimited list.
Property methods: valueDisplayToLogical(), valueGet(), valueIsValid(), valueLogicalToDisplay(), valueLogicalToOdbc(), valueNormalize(), valueSet()


method %OnAfterCreatePage() as %Status
Inherited description: This callback is called after the server-side page object and all of its children are created.
Subclasses can override this to add, remove, or modify items within the page object model, or to provide values for controls.
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.
clientmethod clearRange() [ Language = javascript ]
Click on clear range button.
clientmethod getDialogValue() [ Language = javascript ]
Inherited description: Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.
clientmethod 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.
clientmethod ondialogStart() [ Language = javascript ]
This callback, if defined, is called when the dialog page is loaded.
clientmethod selectIcon(type, href) [ Language = javascript ]
Click on a new cell icon.
clientmethod updateOperator(type) [ Language = javascript ]
Click on a new operator value.
clientmethod updateSample() [ Language = javascript ]
Update the sample.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab