Class AnimationManager

Static manager class used for dynamic animations of controls.

Inheritance

System.Object

AnimationManager

Namespace: Telerik.Windows.Controls.Animation

Assembly: Telerik.Windows.Controls.dll

Syntax

public static class AnimationManager : Object

Fields

AnimationSelectorProperty

Represents the AnimationSelector attached property.

Declaration

public static readonly DependencyProperty AnimationSelectorProperty

Field Value

System.Windows.DependencyProperty

IsAnimationEnabledProperty

Identifies the IsAnimationEnabled attached property.

Declaration

public static readonly DependencyProperty IsAnimationEnabledProperty

Field Value

System.Windows.DependencyProperty

Properties

AnimationSpeedRatio

Gets or sets the global animation speed ration that will be used if no local speed ratio is set.

Declaration

public static double AnimationSpeedRatio { get; set; }

Property Value

System.Double

IsGlobalAnimationEnabled

Gets or sets a value indicating whether the Animation for the whole application will be enabled. This value overrides all other properties.

Declaration

public static bool IsGlobalAnimationEnabled { get; set; }

Property Value

System.Boolean

Methods

GetAnimationSelector(DependencyObject)

Gets the AnimationSelector for the given DependencyObject, normally a control.

Declaration

public static AnimationSelectorBase GetAnimationSelector(DependencyObject obj)

Parameters

System.Windows.DependencyObject obj The target animated object, normally a control.

Returns

AnimationSelectorBase The animation selector for the object.

GetIsAnimationEnabled(DependencyObject)

Gets a value indicating whether animation is enabled for the given Control.

Declaration

public static bool GetIsAnimationEnabled(DependencyObject obj)

Parameters

System.Windows.DependencyObject obj The dependency object for which to check the value, normally a control.

Returns

System.Boolean True if animation is enabled, false otherwise.

Play(FrameworkElement, String)

Plays an animation for the given control and invokes the callback on completion.

Declaration

public static bool Play(FrameworkElement target, string animationName)

Parameters

System.Windows.FrameworkElement target The control for which to play the animation.

System.String animationName The name of the animation.

Returns

System.Boolean True if an animation actually played, false otherwise.

Play(FrameworkElement, String, Action, Boolean, Object[])

Plays an animation for the given control and invokes the callback on completion.

Declaration

public static bool Play(FrameworkElement target, string animationName, Action completeCallback, bool animateSelf, params object[] args)

Parameters

System.Windows.FrameworkElement target The control for which to play the animation.

System.String animationName The name of the animation.

System.Action completeCallback The callback to be called. The callback is always called.

System.Boolean animateSelf Specify if animation is applied on the target. If false, animation is applied on a child of target.

System.Object[] args Optional parameters for the animation, can be provided by the control.

Returns

System.Boolean True if an animation actually played, false otherwise.

Play(FrameworkElement, String, Action, Object[])

Plays an animation for the given control and invokes the callback on completion.

Declaration

public static bool Play(FrameworkElement target, string animationName, Action completeCallback, params object[] args)

Parameters

System.Windows.FrameworkElement target The control for which to play the animation.

System.String animationName The name of the animation.

System.Action completeCallback The callback to be called. The callback is always called.

System.Object[] args Optional parameters for the animation, can be provided by the control.

Returns

System.Boolean True if an animation actually played, false otherwise.

Play(FrameworkElement, String, Boolean)

Plays an animation for the given control and invokes the callback on completion.

Declaration

public static bool Play(FrameworkElement target, string animationName, bool animateSelf)

Parameters

System.Windows.FrameworkElement target The control for which to play the animation.

System.String animationName The name of the animation.

System.Boolean animateSelf Specify if animation is applied on the target. If false, animation is applied on a child of target.

Returns

System.Boolean True if an animation actually played, false otherwise.

SetAnimationSelector(DependencyObject, AnimationSelectorBase)

Sets the Animation selector for the given DependencyObject, normally a Control.

Declaration

public static void SetAnimationSelector(DependencyObject obj, AnimationSelectorBase value)

Parameters

System.Windows.DependencyObject obj The target animated object, normally a control.

AnimationSelectorBase value The AnimationSelector to assign.

SetIsAnimationEnabled(DependencyObject, Boolean)

Sets a value indicating whether animation is enabled for the given Control.

Declaration

public static void SetIsAnimationEnabled(DependencyObject obj, bool value)

Parameters

System.Windows.DependencyObject obj The dependency object for which to check the value, normally a control.

System.Boolean value True if animation should be enabled, false otherwise.

Stop(FrameworkElement, String)

Stops an animation if it is currently active or filling.

Declaration

public static void Stop(FrameworkElement target, string animationName)

Parameters

System.Windows.FrameworkElement target The control to stop the animation for.

System.String animationName The name of the animation to stop.

Stop(FrameworkElement, String, Boolean)

Stops an animation if it is currently active or filling.

Declaration

public static void Stop(FrameworkElement target, string animationName, bool animateSelf)

Parameters

System.Windows.FrameworkElement target The control to stop the animation for.

System.String animationName The name of the animation to stop.

System.Boolean animateSelf Specify if animation is applied on the target. If false, animation is applied on a child of target.

StopIfRunning(FrameworkElement, String)

Stops an animation if it is currently active or filling.

Declaration

public static void StopIfRunning(FrameworkElement target, string animationName)

Parameters

System.Windows.FrameworkElement target The control to stop the animation for.

System.String animationName The name of the animation to stop.

StopIfRunning(FrameworkElement, String, Boolean)

Stops an animation if it is currently active or filling.

Declaration

public static void StopIfRunning(FrameworkElement target, string animationName, bool animateSelf)

Parameters

System.Windows.FrameworkElement target The control to stop the animation for.

System.String animationName The name of the animation to stop.

System.Boolean animateSelf Specify if animation is applied on the target. If false, animation is applied on a child of target.