Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Storyboard.Begin Method (FrameworkContentElement)

Applies the animations associated with this Storyboard to their targets and initiates them.

Namespace:  System.Windows.Media.Animation
Assembly:  PresentationFramework (in PresentationFramework.dll)
public void Begin(
	FrameworkContentElement containingObject
)
You cannot use methods in XAML.

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.

If the targeted properties are already animated, they are replaced using the SnapshotAndReplace handoff behavior.

Storyboards started with this method cannot be paused, resumed, or otherwise interactively controlled after they are started. To make a storyboard controllable, use the Begin or Begin method.

Beginning a storyboard triggers the CurrentStateInvalidated and CurrentGlobalSpeedInvalidated events.

The following example uses a storyboard to animate a TextEffect. The TextEffect is contained within a FrameworkContentElement's name scope.

/*
    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;


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

        private Storyboard myStoryboard;

        public FrameworkContentElementStoryboardExample()
        {

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

            // Create a run of text.
            Run theText = new Run( 
                "Lorem ipsum dolor sit amet, consectetuer adipiscing elit." + 
                "Ut non lacus. Nullam a ligula id leo adipiscing ornare." +
                " Duis mattis. ");   

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

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

            // 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;
            animatedParagraph.Padding = new Thickness(20);

            this.Blocks.Add(animatedParagraph);            
            BlockUIContainer controlsContainer = new BlockUIContainer();                

            // 
            // Create an animation and a storyboard to animate the 
            // text effect. 
            //
            Int32Animation countAnimation = 
                new Int32Animation(0, 127, TimeSpan.FromSeconds(10));            
            Storyboard.SetTargetName(countAnimation, "animatedSpecialEffect");
            Storyboard.SetTargetProperty(countAnimation, 
                new PropertyPath(TextEffect.PositionCountProperty));
            myStoryboard = new Storyboard();
            myStoryboard.Children.Add(countAnimation);

            // 
            // Create a button to start the storyboard. 
            //
            Button beginButton = new Button();
            beginButton.Content = "Begin";
            beginButton.Click += new RoutedEventHandler(beginButton_Clicked);            

            controlsContainer.Child = beginButton; 
            this.Blocks.Add(controlsContainer);

        }

        // Begins the storyboard. 
        private void beginButton_Clicked(object sender, RoutedEventArgs args)
        {

            myStoryboard.Begin(this);                  
        }



    }
}

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

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

.NET Framework

Supported in: 3.5, 3.0
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.