Grid Conditional Format XML

An XML property used to create conditional formats to be applied to the grid. 

To use this property, specify a root node value of Conditions.  The root node should contain Condition Nodes to represent each condition you want to apply.  Each Condition Node should contain values for the elements described below.

NOTE: If your Grid Conditional Format XML includes the greater than or less than character, the text you supply should be wrapped within a CDATA node. For example:

<Conditions><Condition><CustomConditionText><![CDATA[[VacationHours] < 16]]></CustomConditionText><FormatStyle>background:red;color:White;</FormatStyle></Condition></Conditions>

ColumnMember

The name of the column the condition will be checked against.

ConditionText

The string value of the condition to check.

CustomConditionText

Specifies the customized condition of the text you want to format in the grid’s column member.

Example:

<Conditions>

<Condition>

<ColumnMember>Status</ColumnMember>

<ConditionText>In Progress</ConditionText>

<FormatStyle>background:blue;color:White;</FormatStyle>

</Condition>

<Condition>

<CustomConditionText>[Status] like 'd%'</CustomConditionText><FormatStyle>background:red;color:White;</FormatStyle>

</Condition>

</Conditions>

Supported Variables:

•      %ME% – The currently logged in user

•      %Today% – Today's date

•      %CurrentWeekStart% – The first day in the current week

•      %CurrentWeekEnd% – The last day in the current week

•      %CurrentMonthStart% – The first day in the current month

•      %CurrentMonthEnd% – The last day in the current month

•      %CurrentYearStart% – The first day in the current year

•      %CurrentYearEnd% – The last day in the current year

•      %Quarter1Start% – The first day in the first quarter of the current year

•      %Quarter1End% – The last day in the first quarter of the current year

•      %Quarter2Start% – The first day in the second quarter of the current year

•      %Quarter2End% – The last day in the second quarter of the current year

•      %Quarter3Start% – The first day in the third quarter of the current year

•      %Quarter3End% – The last day in the third quarter of the current year

•      %Quarter4Start% – The first day in the fourth quarter of the current year

•      %Quarter4End% – The last day in the fourth quarter of the current year

•      %OneWeekAgoStart% – The first day of the previous week

•      %OneWeekAgoEnd% – The last day of the previous week

•      %TwoWeeksAgoStart% – The first day of the week before last

•      %TwoWeeksAgoEnd% – The last day of the week before last

•      %OneWeekFromNowStart% – The first day of next week

•      %OneWeekFromNowEnd% – The last day of next week

•      %TwoWeeksFromNowStart% – The first day of the week after next

•      %TwoWeeksFromNowEnd% – The last day of the week after next

•      %OneMonthAgoStart% – The first day of last month

•      %OneMonthAgoEnd% – The last day of last month

•      %OneMonthFromNowStart% – The first day of next month

•      %OneMonthFromNowEnd% – The last day of next month

Enabled

A Boolean value that specifies whether the condition is enabled.

Default: True

FormatStyle

The string value of the css style to apply if the condition is met.

TargetColumnMember

Specifies the name of the column to apply the format to if the condition is met. This should be used if the TargetObject is set to Cell.

TargetObject

Controls the object that the FormatStyle will be applied to if the condition is met.

Options: Row, Cell

Default: Row

Back to Top