Export (0) Print
Expand All

FrameworkElement.BeginStoryboard Method (Storyboard, HandoffBehavior)

Begins the sequence of actions contained in the provided storyboard, with options specified for what should happen if the property is already animated.

Namespace: System.Windows
Assembly: PresentationFramework (in presentationframework.dll)

public void BeginStoryboard (
	Storyboard storyboard,
	HandoffBehavior handoffBehavior
)
public void BeginStoryboard (
	Storyboard storyboard, 
	HandoffBehavior handoffBehavior
)
public function BeginStoryboard (
	storyboard : Storyboard, 
	handoffBehavior : HandoffBehavior
)
You cannot use methods in XAML.

Parameters

storyboard

The storyboard to begin.

handoffBehavior

A value of the enumeration that describes behavior to use if a property described in the storyboard is already animated.

Most typical animation scenarios do not use this method. Typically, you create the Storyboard or BeginStoryboard element in markup, and then you place these as the EventTrigger content on an element. When triggered by the event, the animation then runs. Most of the control aspects of a Storyboard can be addressed by properties that are exposed in markup.

For the signatures that do not use the isControllable, parameter, or when that parameter is specified false, the timeline clocks that are associated with the animation are removed as soon as the animation reaches the "Fill" period. Therefore the animation cannot be restarted after running once. Controlling an animation also requires that the storyboard have an x:Name Attribute or be accessible by reference in code.

Handoff behavior can be specified as an attribute of BeginStoryboard.

The following example retrieves a Storyboard from resources, and then runs that Storyboard when an internal event is class handled.

private void OnImage1Animate(object sender, RoutedEventArgs e)
{
    Storyboard s;

    s = (Storyboard)this.FindResource("RotateStoryboard");
    this.BeginStoryboard(s);
}

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0

Community Additions

ADD
Show:
© 2014 Microsoft