Class
RadAnimation

Base class for dynamic control animations.

Definition

Constructors

RadAnimation()

Initializes a new instance of the RadAnimation class.

Declaration

cs-api-definition
protected RadAnimation()

Fields

Empty

The Empty animation does nothing and must be used instead of null if no animation should be played.

Declaration

cs-api-definition
public static readonly RadAnimation Empty

Field Value

RadAnimation

Properties

AnimationName

Gets or sets the name of the animation.

Declaration

cs-api-definition
public string AnimationName { get; set; }

Property Value

string

Remarks

This property is used by the NamedAnimationSelector to identify the correct animation to return.

It is not used outside the NamedAnimationSelector.

AnimationOrigin

Gets or sets the render transform origin of the animated element.

Declaration

cs-api-definition
public virtual Point AnimationOrigin { get; set; }

Property Value

Point

AutoReverse

Gets or sets the AutoReverse property of the internally created storyboard associated with this animation.

Declaration

cs-api-definition
public bool? AutoReverse { get; set; }

Property Value

bool?

Duration

Gets or sets the duration of the animation. Defaults to (0:0:.4) - 400 milliseconds.

Declaration

cs-api-definition
public virtual Duration Duration { get; set; }

Property Value

Duration

Easing

Gets or sets a value describing the easing function to be used for the animation.

Declaration

cs-api-definition
public EasingFunctionBase Easing { get; set; }

Property Value

EasingFunctionBase

FillBehavior

Gets or sets the FillBehavior property of the internally created storyboard, associated with this animation.

Declaration

cs-api-definition
public AnimationFillBehavior FillBehavior { get; set; }

Property Value

AnimationFillBehavior

InitialDelay

Gets or sets an initial delay that will be applied before the animation starts.

Declaration

cs-api-definition
public TimeSpan InitialDelay { get; set; }

Property Value

TimeSpan

RepeatBehavior

Gets or sets the repeat behavior of this RadAnimation instance.

Declaration

cs-api-definition
public RepeatBehavior? RepeatBehavior { get; set; }

Property Value

RepeatBehavior?

SpeedRatio

Gets or sets the value for the SpeedRatio of the Storyboard generated by this animation.

Declaration

cs-api-definition
public double? SpeedRatio { get; set; }

Property Value

double?

Methods

ApplyAnimationValues(PlayAnimationInfo)

Applies already stored (if any) animated values.

Declaration

cs-api-definition
protected virtual void ApplyAnimationValues(PlayAnimationInfo info)

Parameters

info

PlayAnimationInfo

The animation info.

ApplyInitialValues(UIElement)

Sets the initial animation values to the provided target element.

Declaration

cs-api-definition
public virtual void ApplyInitialValues(UIElement target)

Parameters

target

UIElement

The target.

ClearAnimation(UIElement)

Removes any property modifications, applied to the specified element by this instance.

Declaration

cs-api-definition
public virtual void ClearAnimation(UIElement target)

Parameters

target

UIElement

The element which property values are to be cleared.

Remarks

It is assumed that the element has been previously animated by this animation.

Clone()

Creates a clone animation of this instance.

Declaration

cs-api-definition
public RadAnimation Clone()

Returns

RadAnimation

Returns a clone animation of this instance.

CloneCore()

Creates a clone animation of this instance.

Declaration

cs-api-definition
protected virtual RadAnimation CloneCore()

Returns

RadAnimation

Returns a clone of this animation.

CopyAnimationValues(PlayAnimationInfo)

Allows inheritors to store the animated values. This is useful if the animation wants to keep the final values upon storyboard stopping.

Declaration

cs-api-definition
protected virtual void CopyAnimationValues(PlayAnimationInfo info)

Parameters

info

PlayAnimationInfo

The info.

CreateOpposite()

Creates a new instance of this animation that is the reverse of this instance.

Declaration

cs-api-definition
public virtual RadAnimation CreateOpposite()

Returns

RadAnimation

A new instance of this animation that is the reverse of this instance.

CreateStoryboardOverride(UIElement)

Creates a storyboard for this animation.

Declaration

cs-api-definition
protected virtual Storyboard CreateStoryboardOverride(UIElement target)

Parameters

target

UIElement

The target which the storyboard will animate.

Returns

Storyboard

Returns a new storyboard instance.

OnEnded()

Raises the Ended event.

Declaration

cs-api-definition
[Obsolete("This method will be remoevd in Q3 2013. Please use the OnEnded(PlayAnimationInfo info) instead.")]
protected virtual void OnEnded()

OnEnded(PlayAnimationInfo)

Fires the Ended event for the specific target provided in the PlayAnimationInfo object.

Declaration

cs-api-definition
protected virtual void OnEnded(PlayAnimationInfo info)

Parameters

info

PlayAnimationInfo

The info.

OnStarted(PlayAnimationInfo)

Called by the animation manager when the storyboard has been started.

Declaration

cs-api-definition
protected virtual void OnStarted(PlayAnimationInfo info)

Parameters

info

PlayAnimationInfo

The info.

UpdateAnimationOverride(AnimationContext)

Core update routine.

Declaration

cs-api-definition
protected virtual void UpdateAnimationOverride(AnimationContext context)

Parameters

context

AnimationContext

The context that holds information about the animation.

Events

Ended

Occurs when animation has stopped running.

Declaration

cs-api-definition
public event EventHandler<AnimationEndedEventArgs> Ended

Event Value

EventHandler<AnimationEndedEventArgs>