Skip to main content
.NET Framework Class Library
FrameworkElementBeginStoryboard Method (Storyboard)

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

Namespace:   System.Windows
Assembly:  PresentationFramework (in PresentationFramework.dll)
Syntax
Public Sub BeginStoryboard ( _
	storyboard As [%$TOPIC/ms598106_en-us_VS_110_1_0_0_0_0%] _
)
public void BeginStoryboard(
	[%$TOPIC/ms598106_en-us_VS_110_1_0_1_0_0%] storyboard
)
public:
void BeginStoryboard(
	[%$TOPIC/ms598106_en-us_VS_110_1_0_2_0_0%]^ storyboard
)
member BeginStoryboard : 
        storyboard:[%$TOPIC/ms598106_en-us_VS_110_1_0_3_0_0%] -> unit
public function BeginStoryboard(
	storyboard : [%$TOPIC/ms598106_en-us_VS_110_1_0_4_0_0%]
)

Parameters

storyboard
Type: System.Windows.Media.AnimationStoryboard

The storyboard to begin.

Remarks

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.

Examples

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

		Private Sub OnImage1Animate(ByVal sender As Object, ByVal e As RoutedEventArgs)
			Dim s As Storyboard

			s = CType(Me.FindResource("RotateStoryboard"), Storyboard)
			Me.BeginStoryboard(s)
		End Sub
private void OnImage1Animate(object sender, RoutedEventArgs e)
{
    Storyboard s;

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

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1