Animatable.BeginAnimation Method (DependencyProperty, AnimationTimeline, HandoffBehavior)

 

Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the specified HandoffBehavior is used.

Namespace:   System.Windows.Media.Animation
Assembly:  PresentationCore (in PresentationCore.dll)

abstract BeginAnimation : 
        dp:DependencyProperty *
        animation:AnimationTimeline *
        handoffBehavior:HandoffBehavior -> unit
override BeginAnimation : 
        dp:DependencyProperty *
        animation:AnimationTimeline *
        handoffBehavior:HandoffBehavior -> unit

Parameters

dp
Type: System.Windows.DependencyProperty

The property to animate.

animation
Type: System.Windows.Media.Animation.AnimationTimeline

The animation used to animate the specified property.

If handoffBehavior is SnapshotAndReplace and the animation's BeginTime is null, any current animations will be removed and the current value of the property will be held.

If handoffBehavior is SnapshotAndReplace and animation is a null reference, all animations will be removed from the property and the property value will revert back to its base value.

If handoffBehavior is Compose, this method will have no effect if the animation or its BeginTime is null.

handoffBehavior
Type: System.Windows.Media.Animation.HandoffBehavior

A value that specifies how the new animation should interact with any current animations already affecting the property value.

If the animation has a BeginTime that is greater than zero, the animation begins after that amount of time has elapsed from the time the next frame is rendered.

When you apply a Storyboard, AnimationTimeline, or AnimationClock to a property using the Compose HandoffBehavior, any Clock objects previously associated with that property continue to consume system resources; the timing system will not remove these clocks automatically.

To avoid performance issues when you apply a large number of clocks using Compose, you should remove composing clocks from the animated property after they complete. There are several ways to remove a clock.

This is primarily an issue for animations on objects that have a long lifetime. When an object is garbage collected, its clocks will also be disconnected and garbage collected.

For more information about clock objects, see the Animation and Timing System Overview.

The following example shows how to apply animations using different HandoffBehavior settings.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 3.0
Return to top
Show: