Export (0) Print
Expand All

Storyboard.Begin Method (FrameworkContentElement, HandoffBehavior)

Applies the animations associated with this Storyboard to their targets and initiates them, using the specified HandoffBehavior.

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

public void Begin(
	FrameworkContentElement containingObject,
	HandoffBehavior handoffBehavior
)

Parameters

containingObject
Type: System.Windows.FrameworkContentElement
An object contained within the same name scope as the targets of this storyboard's animations. Animations without a TargetName are applied to containingObject.
handoffBehavior
Type: System.Windows.Media.Animation.HandoffBehavior
The behavior the new animation should use to interact with any current animations.

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 does 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 are also disconnected and garbage collected.

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

The following example uses the SnapshotAndReplace HandoffBehavior to animate when the user left-clicks, and the Compose HandoffBehavior when the user right-clicks.


/*
    This example shows how to animate
    a FrameworkContentElement with a storyboard.

*/

using System;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Media;
using System.Windows.Shapes;
using System.Windows.Media.Animation;
using System.Windows.Documents;
using System.Windows.Input;


namespace Microsoft.Samples.Animation.AnimatingWithStoryboards
{
    public class FrameworkContentElementStoryboardWithHandoffBehaviorExample : 
        FlowDocument
    {

        private Storyboard myStoryboard;
        DoubleAnimation xAnimation;
        DoubleAnimation yAnimation;

        public FrameworkContentElementStoryboardWithHandoffBehaviorExample()
        {

            // Create a name scope for the document.
            NameScope.SetNameScope(this, new NameScope());        
            this.Background = Brushes.Orange;

            // Create a run of text.
            Run theText = new Run( 
                "Lorem ipsum dolor sit amet, consectetuer adipiscing elit.");   

            // Create a TextEffect
            TextEffect animatedSpecialEffect = new TextEffect();
            animatedSpecialEffect.Foreground = Brushes.OrangeRed;
            animatedSpecialEffect.PositionStart = 0;
            animatedSpecialEffect.PositionCount = 20;

            TranslateTransform animatedTransform = 
                new TranslateTransform();

            // Assign the transform a name by 
            // registering it with the page, so that
            // it can be targeted by storyboard
            // animations.      
            this.RegisterName("animatedTransform", animatedTransform);             
            animatedSpecialEffect.Transform = animatedTransform;


            // Apply the text effect to the run.
            theText.TextEffects = new TextEffectCollection();
            theText.TextEffects.Add(animatedSpecialEffect);


            // Create a paragraph to contain the run.
            Paragraph animatedParagraph = new Paragraph(theText);
            animatedParagraph.Background = Brushes.LightGray;           

            this.Blocks.Add(animatedParagraph);                           

            //
            // Create a storyboard to animate the
            // text effect's transform.
            //
            myStoryboard = new Storyboard();

            xAnimation = new DoubleAnimation();  
            xAnimation.Duration = TimeSpan.FromSeconds(5);                        
            Storyboard.SetTargetName(xAnimation, "animatedTransform");
            Storyboard.SetTargetProperty(xAnimation, 
                new PropertyPath(TranslateTransform.XProperty));      
            myStoryboard.Children.Add(xAnimation);

            yAnimation = new DoubleAnimation();
            yAnimation.Duration = TimeSpan.FromSeconds(5);           
            Storyboard.SetTargetName(yAnimation, "animatedTransform");
            Storyboard.SetTargetProperty(yAnimation, 
                new PropertyPath(TranslateTransform.YProperty));      
            myStoryboard.Children.Add(yAnimation);            

            this.MouseLeftButtonDown += 
                new MouseButtonEventHandler(document_mouseLeftButtonDown);
            this.MouseRightButtonDown += 
                new MouseButtonEventHandler(document_mouseRightButtonDown);

        }



        // When the user left-clicks, use the 
        // SnapshotAndReplace HandoffBehavior when applying the animation.        
        private void document_mouseLeftButtonDown(object sender, MouseButtonEventArgs e)
        {

            Point clickPoint = Mouse.GetPosition(this);


            // Animate to the target point.
            xAnimation.To = clickPoint.X; 
            yAnimation.To = clickPoint.Y;

            try
            {
                myStoryboard.Begin(this, HandoffBehavior.SnapshotAndReplace);  

            }catch(Exception ex)
            {
                MessageBox.Show(ex.ToString());
            }
        }

        // When the user right-clicks, use the 
        // Compose HandoffBehavior when applying the animation.
        private void document_mouseRightButtonDown(object sender, MouseButtonEventArgs e)
        {


            Point clickPoint = Mouse.GetPosition(this);

            // Animate to the target point.
            xAnimation.To = clickPoint.X;
            yAnimation.To = clickPoint.Y;
            myStoryboard.Begin(this, HandoffBehavior.Compose);  


        }        





    }
}


.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Community Additions

ADD
Show:
© 2014 Microsoft