IWbsField.ConditionalFormula Property

Gets or sets the conditional formula of the field.
Property ConditionalFormula() As String
This language is not supported or no code example is available.
string ConditionalFormula {get; set;}
This language is not supported or no code example is available.

Property Value

string

The formula for conditional formatting of the field in a serialized string format. It contains formula and formatting rules.

Remarks
 

A formula is always prepended with the '=' string. If there is no conditional formatting, this property is set to an empty string.

Formulas are in the format of the en-US culture (with . and , as decimal and list separators). In UI, a user works with formulas in the current culture with localized list and decimal separators.

The value contains 0 or more formatting condition rules.

The rules are separated with the '|$|' delimiter. Each rule consists of a formula, 11 optional formatting parameters and one optional filter. Each of these parts are separated with the '|~|' delimiter. The complete format of the rule parts is as follows:

  • Formula
  • FontBold
  • FontItalic
  • FontUnderline
  • FontStrikeThrough
  • FontColor
  • BackColor
  • PatternColor
  • ColorIndex
  • BackColorIndex
  • PatternColorIndex
  • PatternStyle
  • Filter containing B, M, T flags for Branches, Minutes and Totals. An empty string means all BMT flags.

The boolean parts have values 0 for False, otherwise True. The RGB color parts contain a number created with Color.ToArgb method.

Values -3 are used when a value was not explicitly set.

The RGB colors are used in almost all cases. In this case, the indexed color values are -3. The indexed colors are only used for AUTOMATIC (-1) and NONE (-2).

Version
 
Available since QDV 7.18.655.

.NET Framework

Supported in: 4.8, 4.7, 4.6, 4.5.2

In this article

Definition