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 Sub Begin ( _
	containingObject As FrameworkContentElement, _
	handoffBehavior As HandoffBehavior _


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.

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.

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()

			' Create a paragraph to contain the run.
			Dim animatedParagraph As New Paragraph(theText)
			animatedParagraph.Background = Brushes.LightGray


			' 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))

			yAnimation = New DoubleAnimation()
			yAnimation.Duration = TimeSpan.FromSeconds(5)
			Storyboard.SetTargetName(yAnimation, "animatedTransform")
			Storyboard.SetTargetProperty(yAnimation, New PropertyPath(TranslateTransform.YProperty))

			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

				myStoryboard.Begin(Me, HandoffBehavior.SnapshotAndReplace)

			Catch ex As Exception
			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.2, 4.5.1, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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.

© 2014 Microsoft