Back to Devexpress

FormatConditionRuleDataUpdate.Icon Property

windowsforms-devexpress-dot-xtraeditors-dot-formatconditionruledataupdate-88fe28ae.md

latest3.3 KB
Original Source

FormatConditionRuleDataUpdate.Icon Property

Allows you to display a custom image or a predefined icon.

Namespace : DevExpress.XtraEditors

Assembly : DevExpress.XtraEditors.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

csharp
[XtraSerializableProperty(XtraSerializationVisibility.Content)]
[DXCategory("Appearance")]
public FormatConditionIcon Icon { get; }
vb
<XtraSerializableProperty(XtraSerializationVisibility.Content)>
<DXCategory("Appearance")>
Public ReadOnly Property Icon As FormatConditionIcon

Property Value

TypeDescription
DevExpress.XtraEditors.FormatConditionIcon

An object that specifies an icon or image for the format.

|

Remarks

The Format Rules designer allows you to customize the Icon property at design time.

Use the Icon.Icon property to specify a custom image. Use the Icon.PredefinedName property to choose from predefined glyphs.

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.

csharp
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
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)

See Also

FormatConditionRuleDataUpdate Class

FormatConditionRuleDataUpdate Members

DevExpress.XtraEditors Namespace