FormatConditionRuleDataUpdate.HighlightTime Property

Gets or sets the time during which the format is applied.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v24.2.dll

Declaration

C#

[DefaultValue(600)]
[DXCategory("Behavior")]
[XtraSerializableProperty]
public int HighlightTime { get; set; }

VB.NET

<DefaultValue(600)>
<XtraSerializableProperty>
<DXCategory("Behavior")>
Public Property HighlightTime As Integer

Property Value

Type	Default	Description
Int32	600	The delay in milliseconds after which the format is cleared.

Remarks

Example

This example uses a FormatConditionRuleDataUpdate format to temporarily highlight cells when their values increase. The highlight effect includes a custom background color and icon.

C#

XtraGrid.GridFormatRule gridFormatRule = new DevExpress.XtraGrid.GridFormatRule();
DevExpress.XtraEditors.FormatConditionRuleDataUpdate formatConditionRuleDataUpdate = new DevExpress.XtraEditors.FormatConditionRuleDataUpdate();
gridFormatRule.Column = gridView1.Columns["Change"];
gridFormatRule.Name = "Format1";
formatConditionRuleDataUpdate.HighlightTime = 500;
formatConditionRuleDataUpdate.Icon.PredefinedName = "Flags3_1.png";
formatConditionRuleDataUpdate.PredefinedName = "Green Fill";
formatConditionRuleDataUpdate.Trigger = FormatConditionDataUpdateTrigger.ValueIncreased;
gridFormatRule.Rule = formatConditionRuleDataUpdate;
gridView1.FormatRules.Add(gridFormatRule);

VB.NET

Dim gridFormatRule As New DevExpress.XtraGrid.GridFormatRule()
Dim formatConditionRuleDataUpdate As New DevExpress.XtraEditors.FormatConditionRuleDataUpdate()
gridFormatRule.Column = gridView1.Columns("Change")
gridFormatRule.Name = "Format1"
formatConditionRuleDataUpdate.HighlightTime = 500
formatConditionRuleDataUpdate.Icon.PredefinedName = "Flags3_1.png"
formatConditionRuleDataUpdate.PredefinedName = "Green Fill"
formatConditionRuleDataUpdate.Trigger = XtraEditors.FormatConditionDataUpdateTrigger.ValueIncreased
gridFormatRule.Rule = formatConditionRuleDataUpdate
gridView1.FormatRules.Add(gridFormatRule)