FormatConditionRuleBase.AllowAnimation Property

Gets or sets whether the format is repainted with an animation effect when a cell value changes. Animation effects are supported for specific format rules, only in Data Grid’s GridView, BandedGridView and AdvBandedGridView.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v26.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[DefaultValue(DefaultBoolean.Default)]
[DXCategory("Behavior")]
[XtraSerializableProperty]
public DefaultBoolean AllowAnimation { get; set; }

VB.NET

<DXCategory("Behavior")>
<DefaultValue(DefaultBoolean.Default)>
<XtraSerializableProperty>
Public Property AllowAnimation As DefaultBoolean

Property Value

Type	Default	Description
DefaultBoolean	Default	A value that specifies whether an animation effect is enabled for the format rule.

Available values:

Name	Description	Return Value
True	The value is true.	0
False	The value is false.	1
Default	The value is specified by a global option or a higher-level object.	2

Remarks

Animation effects are supported for the following format rules:

Format rule	Animation effect
FormatConditionRule2ColorScale	Fade effect
FormatConditionRuleDataBar	Progress effect
FormatConditionRuleIconSet	Fade effect
FormatConditionRuleAppearanceBase descendants (FormatConditionRuleValue, FormatConditionRuleExpression, FormatConditionRuleIconSet, FormatConditionRuleTopBottom, FormatConditionRuleDataUpdate and all other format rules that change a cell’s appearance settings based on conditions).	Fade effect

The AllowAnimation property set to Default for the format rules listed above is interpreted as True. Set this property to False to disable animation effects.

The AllowAnimation property is ignored for other format rules.

See GetAllowAnimation to identify whether an animation effect is actually supported by and enabled for the format rule.

Note

Format rule animation effects are not supported in the following cases:

• The height of rows is calculated automatically (see GridOptionsView.RowAutoHeight).
• Cell merging is enabled (see GridOptionsView.AllowCellMerge).
• The GridOptionsView.AutoCalcPreviewLineCount option is enabled, while preview sections are visible.