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

Storyboard.Begin Method (FrameworkContentElement, HandoffBehavior, Boolean)

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)
'Declaration
Public Sub Begin ( _
	containingObject As FrameworkContentElement, _
	handoffBehavior As HandoffBehavior, _
	isControllable As Boolean _
)

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 specified 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.

isControllable
Type: System.Boolean

Declares whether the animation is controllable (can be paused) once started.

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

To interactively control this storyboard, you must specify the same containingObject when calling the interactive methods that you used to begin the storyboard

When this method is called, Clock objects are created for the storyboard and any timelines it contains. These clocks are stored with containingObject.

Beginning a storyboard triggers the CurrentStateInvalidated and CurrentGlobalSpeedInvalidated events.

Using the Compose HandoffBehavior

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 a controllable storyboard to animate a TextEffect. The TextEffect is contained within a FrameworkContentElement's name scope.

'
'    This example shows how to control
'    a storyboard after it has started.
'
'


Imports System
Imports System.Windows
Imports System.Windows.Controls
Imports System.Windows.Media
Imports System.Windows.Shapes
Imports System.Windows.Media.Animation
Imports System.Windows.Documents


Namespace Microsoft.Samples.Animation.AnimatingWithStoryboards
	Public Class FrameworkContentElementControlStoryboardExample
		Inherits FlowDocument

		Private myStoryboard As Storyboard

		Public Sub New()

			' Create a name scope for the document.
			NameScope.SetNameScope(Me, New NameScope())
			Me.Background = Brushes.White

			' Create a run of text.
			Dim theText As 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
			Dim animatedSpecialEffect As 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            
			Me.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.
			Dim animatedParagraph As New Paragraph(theText)
			animatedParagraph.Background = Brushes.LightGray
			animatedParagraph.Padding = New Thickness(20)

			Me.Blocks.Add(animatedParagraph)
			Dim controlsContainer As New BlockUIContainer()

			'
			' Create an animation and a storyboard to animate the
			' text effect.
			'
			Dim countAnimation As 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 some buttons to control the storyboard
			' and a panel to contain them.
			'
			Dim buttonPanel As New StackPanel()
			buttonPanel.Orientation = Orientation.Vertical
			Dim beginButton As New Button()
			beginButton.Content = "Begin"
			AddHandler beginButton.Click, AddressOf beginButton_Clicked
			buttonPanel.Children.Add(beginButton)
			Dim pauseButton As New Button()
			pauseButton.Content = "Pause"
			AddHandler pauseButton.Click, AddressOf pauseButton_Clicked
			buttonPanel.Children.Add(pauseButton)
			Dim resumeButton As New Button()
			resumeButton.Content = "Resume"
			AddHandler resumeButton.Click, AddressOf resumeButton_Clicked
			buttonPanel.Children.Add(resumeButton)
			Dim skipToFillButton As New Button()
			skipToFillButton.Content = "Skip to Fill"
			AddHandler skipToFillButton.Click, AddressOf skipToFillButton_Clicked
			buttonPanel.Children.Add(skipToFillButton)
			Dim setSpeedRatioButton As New Button()
			setSpeedRatioButton.Content = "Triple Speed"
			AddHandler setSpeedRatioButton.Click, AddressOf setSpeedRatioButton_Clicked
			buttonPanel.Children.Add(setSpeedRatioButton)
			Dim stopButton As New Button()
			stopButton.Content = "Stop"
			AddHandler stopButton.Click, AddressOf stopButton_Clicked
			buttonPanel.Children.Add(stopButton)
			Dim removeButton As New Button()
			removeButton.Content = "Remove"
			AddHandler removeButton.Click, AddressOf removeButton_Clicked
			buttonPanel.Children.Add(removeButton)

			controlsContainer.Child = buttonPanel
			Me.Blocks.Add(controlsContainer)

		End Sub

		' Begins the storyboard.
		Private Sub beginButton_Clicked(ByVal sender As Object, ByVal args As RoutedEventArgs)
			' Specifying "true" as the second Begin parameter
			' makes this storyboard controllable.
			myStoryboard.Begin(Me, True)

		End Sub

		' Pauses the storyboard.
		Private Sub pauseButton_Clicked(ByVal sender As Object, ByVal args As RoutedEventArgs)
			 myStoryboard.Pause(Me)

		End Sub

		' Resumes the storyboard.
		Private Sub resumeButton_Clicked(ByVal sender As Object, ByVal args As RoutedEventArgs)
			 myStoryboard.Resume(Me)

		End Sub

		' Advances the storyboard to its fill period.
		Private Sub skipToFillButton_Clicked(ByVal sender As Object, ByVal args As RoutedEventArgs)
			 myStoryboard.SkipToFill(Me)

		End Sub

		' Updates the storyboard's speed.
		Private Sub setSpeedRatioButton_Clicked(ByVal sender As Object, ByVal args As RoutedEventArgs)
			' Makes the storyboard progress three times as fast as normal.
			myStoryboard.SetSpeedRatio(Me, 3)

		End Sub

		' Stops the storyboard.
		Private Sub stopButton_Clicked(ByVal sender As Object, ByVal args As RoutedEventArgs)
			 myStoryboard.Stop(Me)

		End Sub

		' Removes the storyboard.
		Private Sub removeButton_Clicked(ByVal sender As Object, ByVal args As RoutedEventArgs)
			 myStoryboard.Remove(Me)

		End Sub

	End Class
End Namespace

The next 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.
'
'


Imports System
Imports System.Windows
Imports System.Windows.Controls
Imports System.Windows.Media
Imports System.Windows.Shapes
Imports System.Windows.Media.Animation
Imports System.Windows.Documents
Imports System.Windows.Input


Namespace Microsoft.Samples.Animation.AnimatingWithStoryboards
	Public Class FrameworkContentElementStoryboardWithHandoffBehaviorExample
		Inherits FlowDocument

		Private myStoryboard As Storyboard
		Private xAnimation As DoubleAnimation
		Private yAnimation As DoubleAnimation

		Public Sub New()

			' Create a name scope for the document.
			NameScope.SetNameScope(Me, New NameScope())
			Me.Background = Brushes.Orange

			' Create a run of text.
			Dim theText As New Run("Lorem ipsum dolor sit amet, consectetuer adipiscing elit.")

			' Create a TextEffect
			Dim animatedSpecialEffect As New TextEffect()
			animatedSpecialEffect.Foreground = Brushes.OrangeRed
			animatedSpecialEffect.PositionStart = 0
			animatedSpecialEffect.PositionCount = 20

			Dim animatedTransform As New TranslateTransform()

			' Assign the transform a name by 
			' registering it with the page, so that
			' it can be targeted by storyboard
			' animations.      
			Me.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.
			Dim animatedParagraph As New Paragraph(theText)
			animatedParagraph.Background = Brushes.LightGray

			Me.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)

			AddHandler MouseLeftButtonDown, AddressOf document_mouseLeftButtonDown
			AddHandler MouseRightButtonDown, AddressOf document_mouseRightButtonDown

		End Sub



		' When the user left-clicks, use the 
		' SnapshotAndReplace HandoffBehavior when applying the animation.        
		Private Sub document_mouseLeftButtonDown(ByVal sender As Object, ByVal e As MouseButtonEventArgs)

			Dim clickPoint As Point = Mouse.GetPosition(Me)


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

			Try
				myStoryboard.Begin(Me, HandoffBehavior.SnapshotAndReplace)

			Catch ex As Exception
				MessageBox.Show(ex.ToString())
			End Try
		End Sub

		' When the user right-clicks, use the 
		' Compose HandoffBehavior when applying the animation.
		Private Sub document_mouseRightButtonDown(ByVal sender As Object, ByVal e As MouseButtonEventArgs)


			Dim clickPoint As Point = Mouse.GetPosition(Me)

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


		End Sub





	End Class
End Namespace

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.