Skip to content

Latest commit

 

History

History
57 lines (45 loc) · 2.92 KB

beginstoryboard_storyboard.md

File metadata and controls

57 lines (45 loc) · 2.92 KB
Raw
-api-id -api-type
P:Microsoft.UI.Xaml.Media.Animation.BeginStoryboard.Storyboard
winrt property

Microsoft.UI.Xaml.Media.Animation.BeginStoryboard.Storyboard

-description

Gets or sets the Storyboard that this BeginStoryboard starts.

-xaml-syntax

<BeginStoryboard>
  <Storyboard ...>
    oneOrMoreAnimations
  </Storyboard>
</BeginStoryboard>

-xaml-values

oneOrMoreAnimations
oneOrMoreAnimationsOne or more animation types that derive from Timeline. These provide the value of Storyboard.Children.
## -property-value The [Storyboard](storyboard.md) that the [BeginStoryboard](beginstoryboard.md) starts. The default is null.

-remarks

Triggers, EventTrigger, and BeginStoryboard are not commonly used. These API mainly exist for compatibility in XAML originally used for Microsoft Silverlight. For most scenarios where event triggers were used previously, you should either use visual states, or start animations by writing a Loaded handler that looks up an animation in page-level resources and then calls Begin on the animation's main Storyboard. For more info, see XAML Control templates or Storyboarded animations.

-examples

This XAML example shows the basic structure for using FrameworkElement.Triggers with its default FrameworkElement.Loaded trigger behavior to run a storyboarded animation. This XAML shows the EventTrigger and BeginStoryboard container elements in proper relationship with each using their XAML content property syntax and unnecessary property element tags (such as BeginStoryboard.Storyboard) omitted.

<Canvas Width="200" Height="200" x:Name="animatedcanvas" Background="Red">
    <Canvas.Triggers>
        <EventTrigger>
            <BeginStoryboard>
                <Storyboard x:Name="ColorStoryboard">
                   <!-- Animate the background of the canvas to green over 4 seconds. -->
                    <ColorAnimation Storyboard.TargetName="animatedcanvas"
                      Storyboard.TargetProperty="(Panel.Background).(SolidColorBrush.Color)"
                      To="Green" Duration="0:0:4" />
                </Storyboard>
            </BeginStoryboard>
        </EventTrigger>
    </Canvas.Triggers>
</Canvas>

-see-also

XAML syntax guide