BeginStoryboard Method (Storyboard)
Collapse the table of content
Expand the table of content

FrameworkElement.BeginStoryboard Method (Storyboard)

 

Begins the sequence of actions that are contained in the provided storyboard.

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

public void BeginStoryboard(
	Storyboard storyboard
)

Parameters

storyboard
Type: System.Windows.Media.Animation.Storyboard

The storyboard to begin.

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 Directive or be accessible by reference in code.

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);
}

.NET Framework
Available since 3.0
Return to top
Show:
© 2016 Microsoft