This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRISOpens in a new window, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions pageOpens in a new window (login required).

Caché & Ensemble 2018.1.5Opens in a new window > Class Reference > %SYS namespace > %CSP.Util.Condition


serial class %CSP.Util.Condition extends %Library.SerialObject, %XML.Adaptor

This class is used internally by Caché. You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class.

Defines a color-condition for a CSPX Table Pane.

Property Inventory

Method Inventory


property CellStyle as %String (MAXLEN = 200);
Style to apply to cell if condition is true.
This is a CSS style string: e.g., "color: red;"
Property methods: CellStyleDisplayToLogical(), CellStyleGet(), CellStyleIsValid(), CellStyleLogicalToDisplay(), CellStyleLogicalToOdbc(), CellStyleNormalize(), CellStyleSet()
property ColumnName as %String (MAXLEN = 50);
Name of column condition applies to
Property methods: ColumnNameDisplayToLogical(), ColumnNameGet(), ColumnNameIsValid(), ColumnNameLogicalToDisplay(), ColumnNameLogicalToOdbc(), ColumnNameNormalize(), ColumnNameSet()
property Predicate as %String (VALUELIST = ",GT,EQ,LT,NEQ,GTEQ,LTEQ,EXTEQ,STARTWITH,NEQAND") [ InitialExpression = "EQ" ];
Comparison predicate applied to column value
Property methods: PredicateDisplayToLogical(), PredicateGet(), PredicateIsValid(), PredicateLogicalToDisplay(), PredicateLogicalToOdbc(), PredicateNormalize(), PredicateSet()
property RowStyle as %String (MAXLEN = 200);
Style to apply to row if condition is true.
This is a CSS style string: e.g., "color: red;"
Property methods: RowStyleDisplayToLogical(), RowStyleGet(), RowStyleIsValid(), RowStyleLogicalToDisplay(), RowStyleLogicalToOdbc(), RowStyleNormalize(), RowStyleSet()
property TargetColumn as %String (MAXLEN = 50);
Name of column condition to apply CellStyle to; use ColumnName if this is null.
Property methods: TargetColumnDisplayToLogical(), TargetColumnGet(), TargetColumnIsValid(), TargetColumnLogicalToDisplay(), TargetColumnLogicalToOdbc(), TargetColumnNormalize(), TargetColumnSet()
property Value as %String (MAXLEN = 100);
Literal value compared against column value
Note: if value is enclosed in {}, then it is a column name...
Property methods: ValueDisplayToLogical(), ValueGet(), ValueIsValid(), ValueLogicalToDisplay(), ValueLogicalToOdbc(), ValueNormalize(), ValueSet()


method Eval(pRS As %ResultSet) as %Boolean
Evaluate this condition using the values in the provided ResultSet. Deprecated: use Eval2
method Eval2(ByRef pIndex As %String, ByRef pValues As %String) as %Boolean
Evaluate this condition using the values in the provided row arrays.
method GenerateCode() as %String
Utility method to generate code for this object

Inherited Members

Inherited Methods

FeedbackOpens in a new window