Class
AnimationManager

Static manager class used for dynamic animations of controls.

Definition

Namespace:Telerik.Windows.Controls.Animation

Assembly:Telerik.Windows.Controls.dll

Syntax:

cs-api-definition
public static class AnimationManager

Inheritance: objectAnimationManager

Fields

AnimationSelectorProperty

Represents the AnimationSelector attached property.

Declaration

cs-api-definition
public static readonly DependencyProperty AnimationSelectorProperty

Field Value

DependencyProperty

IsAnimationEnabledProperty

Identifies the IsAnimationEnabled attached property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsAnimationEnabledProperty

Field Value

DependencyProperty

Properties

AnimationSpeedRatio

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

Declaration

cs-api-definition
public static double AnimationSpeedRatio { get; set; }

Property Value

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

cs-api-definition
public static bool IsGlobalAnimationEnabled { get; set; }

Property Value

bool

Methods

GetAnimationSelector(DependencyObject)

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

Declaration

cs-api-definition
public static AnimationSelectorBase GetAnimationSelector(DependencyObject obj)

Parameters

obj

DependencyObject

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

cs-api-definition
public static bool GetIsAnimationEnabled(DependencyObject obj)

Parameters

obj

DependencyObject

The dependency object for which to check the value, normally a control.

Returns

bool

True if animation is enabled, false otherwise.

Play(FrameworkElement, string)

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

Declaration

cs-api-definition
public static bool Play(FrameworkElement target, string animationName)

Parameters

target

FrameworkElement

The control for which to play the animation.

animationName

string

The name of the animation.

Returns

bool

True if an animation actually played, false otherwise.

Play(FrameworkElement, string, Action, bool, params object[])

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

Declaration

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

Parameters

target

FrameworkElement

The control for which to play the animation.

animationName

string

The name of the animation.

completeCallback

Action

The callback to be called. The callback is always called.

animateSelf

bool

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

args

object[]

Optional parameters for the animation, can be provided by the control.

Returns

bool

True if an animation actually played, false otherwise.

Play(FrameworkElement, string, Action, params object[])

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

Declaration

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

Parameters

target

FrameworkElement

The control for which to play the animation.

animationName

string

The name of the animation.

completeCallback

Action

The callback to be called. The callback is always called.

args

object[]

Optional parameters for the animation, can be provided by the control.

Returns

bool

True if an animation actually played, false otherwise.

Play(FrameworkElement, string, bool)

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

Declaration

cs-api-definition
public static bool Play(FrameworkElement target, string animationName, bool animateSelf)

Parameters

target

FrameworkElement

The control for which to play the animation.

animationName

string

The name of the animation.

animateSelf

bool

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

Returns

bool

True if an animation actually played, false otherwise.

SetAnimationSelector(DependencyObject, AnimationSelectorBase)

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

Declaration

cs-api-definition
public static void SetAnimationSelector(DependencyObject obj, AnimationSelectorBase value)

Parameters

obj

DependencyObject

The target animated object, normally a control.

value

AnimationSelectorBase

The AnimationSelector to assign.

SetIsAnimationEnabled(DependencyObject, bool)

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

Declaration

cs-api-definition
public static void SetIsAnimationEnabled(DependencyObject obj, bool value)

Parameters

obj

DependencyObject

The dependency object for which to check the value, normally a control.

value

bool

True if animation should be enabled, false otherwise.

Stop(FrameworkElement, string)

Stops an animation if it is currently active or filling.

Declaration

cs-api-definition
public static void Stop(FrameworkElement target, string animationName)

Parameters

target

FrameworkElement

The control to stop the animation for.

animationName

string

The name of the animation to stop.

Stop(FrameworkElement, string, bool)

Stops an animation if it is currently active or filling.

Declaration

cs-api-definition
public static void Stop(FrameworkElement target, string animationName, bool animateSelf)

Parameters

target

FrameworkElement

The control to stop the animation for.

animationName

string

The name of the animation to stop.

animateSelf

bool

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

cs-api-definition
public static void StopIfRunning(FrameworkElement target, string animationName)

Parameters

target

FrameworkElement

The control to stop the animation for.

animationName

string

The name of the animation to stop.

StopIfRunning(FrameworkElement, string, bool)

Stops an animation if it is currently active or filling.

Declaration

cs-api-definition
public static void StopIfRunning(FrameworkElement target, string animationName, bool animateSelf)

Parameters

target

FrameworkElement

The control to stop the animation for.

animationName

string

The name of the animation to stop.

animateSelf

bool

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