GaugeControlBase.EnableAnimation Property

Gets or sets a value specifying whether value indicators should be animated when changing their values.

Namespace: DevExpress.Xpf.Gauges

Assembly: DevExpress.Xpf.Gauges.v24.1.dll

NuGet Package: DevExpress.Wpf.Gauges

Declaration

C#

public bool EnableAnimation { get; set; }

VB.NET

Public Property EnableAnimation As Boolean

Property Value

Type	Description
Boolean	true to enable animation; otherwise, false.

Remarks

When the EnableAnimation property is set to true, all value indicators of a Gauge control will smoothly display changing values. Note that an indicator’s ValueIndicatorBase.Value can be changed either programmatically or by using a mouse-click (when the ValueIndicatorBase.IsInteractive property of the corresponding indicator is set to true).

By default, the preset animation effect is used. If you want to change default settings, you should edit the ValueIndicatorBase.Animation property of a value indicator (e.g. to change the animation duration or animation function). For more details, refer to How to: Customize Animation Settings.

Use the AnimationBase.Enable property to animate (inanimate) a concrete gauge’s indicator, if the GaugeControlBase.EnableAnimation property is set to false (true).

Example

This example demonstrates how to use animation effects in DXGauges.

To activate animation, set the GaugeControlBase.EnableAnimation property to True. After that, it becomes possible to customize the animation’s duration and easing function via its IndicatorAnimation.Duration and IndicatorAnimation.EasingFunction properties.

MainWindow.xaml

<Window x:Class="DXGauges_Animation.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:dxga="http://schemas.devexpress.com/winfx/2008/xaml/gauges"
        Title="MainWindow" Height="350" Width="525" >
    <Grid>
        <!--region #EnableAnimation-->
        <dxga:CircularGaugeControl EnableAnimation="True">
        <!--endregion #EnableAnimation-->
            <dxga:CircularGaugeControl.Scales>
                <dxga:ArcScale>
                    <dxga:ArcScale.Needles>
                        <!--region #EnableEditing-->
                        <dxga:ArcScaleNeedle IsInteractive="True">
                        <!--endregion #EnableEditing-->
                            <dxga:ArcScaleNeedle.Animation>
                                <dxga:IndicatorAnimation Duration="00:00:02.0000000">
                                    <dxga:IndicatorAnimation.EasingFunction>
                                        <BounceEase/>
                                    </dxga:IndicatorAnimation.EasingFunction>
                                </dxga:IndicatorAnimation>
                            </dxga:ArcScaleNeedle.Animation>
                        </dxga:ArcScaleNeedle>
                    </dxga:ArcScale.Needles>
                </dxga:ArcScale>
            </dxga:CircularGaugeControl.Scales>
        </dxga:CircularGaugeControl>
    </Grid>
</Window>