FrameworkElement.BeginStoryboard Method

Definition

Lance la séquence d'actions contenues dans la table de montage séquentiel fournie.Begins the sequence of actions contained in the provided storyboard.

Overloads

BeginStoryboard(Storyboard)

Commence la séquence d'actions contenues dans la table de montage séquentiel fournie.Begins the sequence of actions that are contained in the provided storyboard.

BeginStoryboard(Storyboard, HandoffBehavior)

Lance la séquence d'actions contenues dans la table de montage séquentiel fournie, les options précisant ce qui doit se produire si la propriété est déjà animée.Begins the sequence of actions contained in the provided storyboard, with options specified for what should happen if the property is already animated.

BeginStoryboard(Storyboard, HandoffBehavior, Boolean)

Lance la séquence d'actions contenues dans la table de montage séquentiel fournie, avec un état spécifié pour le contrôle de l'animation après qu'elle ait démarré.Begins the sequence of actions contained in the provided storyboard, with specified state for control of the animation after it is started.

BeginStoryboard(Storyboard)

Commence la séquence d'actions contenues dans la table de montage séquentiel fournie.Begins the sequence of actions that are contained in the provided storyboard.

public:
 void BeginStoryboard(System::Windows::Media::Animation::Storyboard ^ storyboard);
public void BeginStoryboard (System.Windows.Media.Animation.Storyboard storyboard);
member this.BeginStoryboard : System.Windows.Media.Animation.Storyboard -> unit
Public Sub BeginStoryboard (storyboard As Storyboard)

Parameters

storyboard
Storyboard

Table de montage séquentiel à lancer.The storyboard to begin.

Examples

L’exemple suivant récupère un Storyboard à partir de ressources, puis exécute ce Storyboard lorsqu’un événement interne est géré par la classe.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);
}
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

Remarks

La plupart des scénarios d’animation classiques n’utilisent pas cette méthode.Most typical animation scenarios do not use this method. En général, vous créez l’élément Storyboard ou BeginStoryboard dans le balisage, puis vous les placez en tant que EventTrigger contenu sur un élément.Typically, you create the Storyboard or BeginStoryboard element in markup, and then you place these as the EventTrigger content on an element. Lorsqu’elle est déclenchée par l’événement, l’animation s’exécute.When triggered by the event, the animation then runs. La plupart des aspects de contrôle d’un Storyboard peuvent être traités par les propriétés exposées dans le balisage.Most of the control aspects of a Storyboard can be addressed by properties that are exposed in markup.

Pour les signatures qui n’utilisent pas l' isControllable, le paramètre, ou lorsque ce paramètre est spécifié false, les horloges de chronologie associées à l’animation sont supprimées dès que l’animation atteint la période de « remplissage ».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. Par conséquent, l’animation ne peut pas être redémarrée après une seule exécution.Therefore the animation cannot be restarted after running once. Le contrôle d’une animation requiert également que la table de montage séquentiel ait une directive x :Name ou soit accessible par référence dans le code.Controlling an animation also requires that the storyboard have an x:Name Directive or be accessible by reference in code.

BeginStoryboard(Storyboard, HandoffBehavior)

Lance la séquence d'actions contenues dans la table de montage séquentiel fournie, les options précisant ce qui doit se produire si la propriété est déjà animée.Begins the sequence of actions contained in the provided storyboard, with options specified for what should happen if the property is already animated.

public:
 void BeginStoryboard(System::Windows::Media::Animation::Storyboard ^ storyboard, System::Windows::Media::Animation::HandoffBehavior handoffBehavior);
public void BeginStoryboard (System.Windows.Media.Animation.Storyboard storyboard, System.Windows.Media.Animation.HandoffBehavior handoffBehavior);
member this.BeginStoryboard : System.Windows.Media.Animation.Storyboard * System.Windows.Media.Animation.HandoffBehavior -> unit
Public Sub BeginStoryboard (storyboard As Storyboard, handoffBehavior As HandoffBehavior)

Parameters

storyboard
Storyboard

Table de montage séquentiel à lancer.The storyboard to begin.

handoffBehavior
HandoffBehavior

Valeur de l'énumération qui décrit le comportement à adopter si une propriété décrite dans la table de montage séquentiel est déjà animée.A value of the enumeration that describes behavior to use if a property described in the storyboard is already animated.

Examples

L’exemple suivant récupère un Storyboard à partir de ressources, puis exécute ce Storyboard lorsqu’un événement interne est géré par la classe.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);
}
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

Remarks

La plupart des scénarios d’animation classiques n’utilisent pas cette méthode.Most typical animation scenarios do not use this method. En général, vous créez l’élément Storyboard ou BeginStoryboard dans le balisage, puis vous les placez en tant que EventTrigger contenu sur un élément.Typically, you create the Storyboard or BeginStoryboard element in markup, and then you place these as the EventTrigger content on an element. Lorsqu’elle est déclenchée par l’événement, l’animation s’exécute.When triggered by the event, the animation then runs. La plupart des aspects de contrôle d’un Storyboard peuvent être traités par les propriétés exposées dans le balisage.Most of the control aspects of a Storyboard can be addressed by properties that are exposed in markup.

Pour les signatures qui n’utilisent pas l' isControllable, le paramètre, ou lorsque ce paramètre est spécifié false, les horloges de chronologie associées à l’animation sont supprimées dès que l’animation atteint la période de « remplissage ».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. Par conséquent, l’animation ne peut pas être redémarrée après une seule exécution.Therefore the animation cannot be restarted after running once. Le contrôle d’une animation requiert également que la table de montage séquentiel ait une directive x :Name ou soit accessible par référence dans le code.Controlling an animation also requires that the storyboard have an x:Name Directive or be accessible by reference in code.

Le comportement de transfert peut être spécifié en tant qu’attribut de BeginStoryboard.Handoff behavior can be specified as an attribute of BeginStoryboard.

Utilisation du message HandoffBehavior composeUsing the Compose HandoffBehavior

Lorsque vous appliquez une Storyboard, AnimationTimelineou AnimationClock à une propriété à l’aide de la HandoffBehaviorCompose, tous les objets Clock précédemment associés à cette propriété continuent à consommer des ressources système. le système de minutage ne supprime pas automatiquement les horloges.When you apply a Storyboard, AnimationTimeline, or AnimationClock to a property by using the Compose HandoffBehavior, any Clock objects previously associated with that property continue to consume system resources; the timing system does not remove the clocks automatically.

Pour éviter les problèmes de performances lorsque vous appliquez un grand nombre d’horloges à l’aide d' Compose, vous devez supprimer la composition des horloges de la propriété animée une fois qu’elles sont terminées.To avoid performance issues when you apply a large number of clocks by using Compose, you should remove composing clocks from the animated property after they complete. Il existe plusieurs façons de supprimer une horloge :There are several ways to remove a clock:

Il s’agit principalement d’un problème pour les animations sur des objets qui ont une durée de vie longue.This is primarily an issue for animations on objects that have a long lifetime. Lorsqu’un objet est récupéré par le garbage collector, ses horloges sont également déconnectées et récupérées par le garbage collector.When an object is garbage collected, its clocks are also disconnected and garbage collected.

Pour plus d’informations sur les objets Clock, consultez vue d’ensemble du système d’animation et de minutage.For more information about clock objects, see Animation and Timing System Overview.

BeginStoryboard(Storyboard, HandoffBehavior, Boolean)

Lance la séquence d'actions contenues dans la table de montage séquentiel fournie, avec un état spécifié pour le contrôle de l'animation après qu'elle ait démarré.Begins the sequence of actions contained in the provided storyboard, with specified state for control of the animation after it is started.

public:
 void BeginStoryboard(System::Windows::Media::Animation::Storyboard ^ storyboard, System::Windows::Media::Animation::HandoffBehavior handoffBehavior, bool isControllable);
public void BeginStoryboard (System.Windows.Media.Animation.Storyboard storyboard, System.Windows.Media.Animation.HandoffBehavior handoffBehavior, bool isControllable);
member this.BeginStoryboard : System.Windows.Media.Animation.Storyboard * System.Windows.Media.Animation.HandoffBehavior * bool -> unit
Public Sub BeginStoryboard (storyboard As Storyboard, handoffBehavior As HandoffBehavior, isControllable As Boolean)

Parameters

storyboard
Storyboard

Table de montage séquentiel à lancer.The storyboard to begin.

handoffBehavior
HandoffBehavior

Valeur de l'énumération qui décrit le comportement à adopter si une propriété décrite dans la table de montage séquentiel est déjà animée.A value of the enumeration that describes behavior to use if a property described in the storyboard is already animated.

isControllable
Boolean

Déclare si l'animation est contrôlable (peut être suspendue) après avoir démarré.Declares whether the animation is controllable (can be paused) after it is started.

Remarks

La plupart des scénarios d’animation classiques n’utilisent pas cette méthode.Most typical animation scenarios do not use this method. En général, vous créez l’élément Storyboard ou BeginStoryboard dans le balisage, puis vous les placez en tant que EventTrigger contenu sur un élément.Typically, you create the Storyboard or BeginStoryboard element in markup, and then you place these as the EventTrigger content on an element. Lorsqu’elle est déclenchée par l’événement, l’animation s’exécute.When triggered by the event, the animation then runs. La plupart des aspects de contrôle d’un Storyboard peuvent être traités par les propriétés exposées dans le balisage.Most of the control aspects of a Storyboard can be addressed by properties that are exposed in markup.

Pour les signatures qui n’utilisent pas l' isControllable, le paramètre, ou lorsque ce paramètre est spécifié false, les horloges de chronologie associées à l’animation sont supprimées dès que l’animation atteint la période de « remplissage ».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. Par conséquent, l’animation ne peut pas être redémarrée après une seule exécution.Therefore the animation cannot be restarted after running once. Le contrôle d’une animation requiert également que la table de montage séquentiel ait une directive x :Name ou soit accessible par référence dans le code.Controlling an animation also requires that the storyboard have an x:Name Directive or be accessible by reference in code.

Le comportement de transfert peut être spécifié en tant qu’attribut de BeginStoryboard.Handoff behavior can be specified as an attribute of BeginStoryboard.

Utilisation du message HandoffBehavior composeUsing the Compose HandoffBehavior

Lorsque vous appliquez une Storyboard, AnimationTimelineou AnimationClock à une propriété à l’aide de la HandoffBehaviorCompose, tous les objets Clock précédemment associés à cette propriété continuent à consommer des ressources système. le système de minutage ne supprime pas automatiquement les horloges.When you apply a Storyboard, AnimationTimeline, or AnimationClock to a property by using the Compose HandoffBehavior, any Clock objects previously associated with that property continue to consume system resources; the timing system does not remove the clocks automatically.

Pour éviter les problèmes de performances lorsque vous appliquez un grand nombre d’horloges à l’aide d' Compose, vous devez supprimer la composition des horloges de la propriété animée une fois qu’elles sont terminées.To avoid performance issues when you apply a large number of clocks by using Compose, you should remove composing clocks from the animated property after they complete. Il existe plusieurs façons de supprimer une horloge :There are several ways to remove a clock:

Il s’agit principalement d’un problème pour les animations sur des objets qui ont une durée de vie longue.This is primarily an issue for animations on objects that have a long lifetime. Lorsqu’un objet est récupéré par le garbage collector, ses horloges sont également déconnectées et récupérées par le garbage collector.When an object is garbage collected, its clocks are also disconnected and garbage collected.

Pour plus d’informations sur les objets Clock, consultez vue d’ensemble du système d’animation et de minutage.For more information about clock objects, see Animation and Timing System Overview.

Applies to