Storyboard.Begin Method (FrameworkContentElement)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

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

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

Public Sub Begin (
	containingObject As FrameworkContentElement


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.

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

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

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

			' Create a button to start the storyboard.
			Dim beginButton As New Button()
			beginButton.Content = "Begin"
			AddHandler beginButton.Click, AddressOf beginButton_Clicked

			controlsContainer.Child = beginButton

		End Sub

		' Begins the storyboard.
		Private Sub beginButton_Clicked(ByVal sender As Object, ByVal args As RoutedEventArgs)

		End Sub

	End Class
End Namespace

.NET Framework
Available since 3.0
Return to top