BeginStoryboard.Name Property
Gets or sets the name of the BeginStoryboard object. By naming the BeginStoryboard object, the Storyboard can be controlled after it is started.
Assembly: PresentationFramework (in PresentationFramework.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation
To be able to pause, resume, or otherwise interactively control a Storyboard, set the Name property of its BeginStoryboard and use a ControllableStoryboardAction object like PauseStoryboard, ResumeStoryboard, or StopStoryboard to reference this name. If the Name of BeginStoryboard is unspecified, the Storyboard cannot be interactively affected after it is begun; furthermore, when the Storyboard ends or enters its Fill period, the animation clocks are disposed of. See How to: Use Event Triggers to Control a Storyboard After It Starts for more information.
This example shows how to control a Storyboard after it starts. To start a Storyboard by using XAML, use BeginStoryboard, which distributes the animations to the objects and properties they animate and then starts the storyboard. If you give BeginStoryboard a name by specifying its Name property, you make it a controllable storyboard. You can then interactively control the storyboard after it starts.
Use the following storyboard actions together with EventTrigger objects to control a storyboard.
PauseStoryboard: Pauses the storyboard.
ResumeStoryboard: Resumes a paused storyboard.
SetStoryboardSpeedRatio: Changes the storyboard speed.
SkipStoryboardToFill: Advances a storyboard to the end of its fill period, if it has one.
StopStoryboard: Stops the storyboard.
RemoveStoryboard: Removes the storyboard, freeing resources.
The following example uses controllable storyboard actions to interactively control a storyboard.
Note: To see an example of controlling a storyboard by using code, see How to: Control a Storyboard After It Starts.
<Page xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" WindowTitle="Controlling a Storyboard" > <StackPanel Margin="20" > <!-- This rectangle is animated. --> <Rectangle Name="myRectangle" Width="100" Height="20" Margin="12,0,0,5" Fill="#AA3333FF" HorizontalAlignment="Left" /> <!-- This StackPanel contains all the Buttons. --> <StackPanel Orientation="Horizontal" Margin="0,30,0,0"> <Button Name="BeginButton">Begin</Button> <Button Name="PauseButton">Pause</Button> <Button Name="ResumeButton">Resume</Button> <Button Name="SeekButton">Seek</Button> <Button Name="SkipToFillButton">Skip To Fill</Button> <Button Name="SetSpeedRatioButton">Triple Speed</Button> <Button Name="StopButton">Stop</Button> <StackPanel.Triggers> <!-- Begin the Storyboard --> <EventTrigger RoutedEvent="Button.Click" SourceName="BeginButton"> <BeginStoryboard Name="MyBeginStoryboard"> <Storyboard > <DoubleAnimation Storyboard.TargetName="myRectangle" Storyboard.TargetProperty="Width" Duration="0:0:5" From="100" To="500" /> </Storyboard> </BeginStoryboard> </EventTrigger> <!-- Pause the Storyboard --> <EventTrigger RoutedEvent="Button.Click" SourceName="PauseButton"> <PauseStoryboard BeginStoryboardName="MyBeginStoryboard" /> </EventTrigger> <!-- Resume the Storyboard --> <EventTrigger RoutedEvent="Button.Click" SourceName="ResumeButton"> <ResumeStoryboard BeginStoryboardName="MyBeginStoryboard" /> </EventTrigger> <!-- Seek one second into the storyboard's active period. --> <EventTrigger RoutedEvent="Button.Click" SourceName="SeekButton"> <SeekStoryboard BeginStoryboardName="MyBeginStoryboard" Offset="0:0:1" Origin="BeginTime" /> </EventTrigger> <!-- Skip to Fill --> <EventTrigger RoutedEvent="Button.Click" SourceName="SkipToFillButton"> <SkipStoryboardToFill BeginStoryboardName="MyBeginStoryboard" /> </EventTrigger> <!-- Stop the Storyboard --> <EventTrigger RoutedEvent="Button.Click" SourceName="StopButton"> <StopStoryboard BeginStoryboardName="MyBeginStoryboard" /> </EventTrigger> <!-- Triple the speed of the Storyboard --> <EventTrigger RoutedEvent="Button.Click" SourceName="SetSpeedRatioButton"> <SetStoryboardSpeedRatio SpeedRatio="3" BeginStoryboardName="MyBeginStoryboard" /> </EventTrigger> </StackPanel.Triggers> </StackPanel> </StackPanel> </Page>
For additional examples, see the Animation Example Gallery.
More Code
| How to: Animate a Property by Using a Storyboard | This example shows how to use a Storyboard to animate properties. To animate a property by using a Storyboard, create an animation for each property that you want to animate and also create a Storyboard to contain the animations. |
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.
