FrameworkElement.BeginStoryboard Méthode

Définition

Espace de noms:

System.Windows

Assembly:

PresentationFramework.dll

Commence la séquence d’actions contenues dans le storyboard fourni.

Surcharges

BeginStoryboard(Storyboard)	Commence la séquence d’actions contenues dans le storyboard fourni.
BeginStoryboard(Storyboard, HandoffBehavior)	Commence la séquence d’actions contenues dans le storyboard fourni, avec des options spécifiées pour ce qui doit se produire si la propriété est déjà animée.
BeginStoryboard(Storyboard, HandoffBehavior, Boolean)	Commence la séquence d’actions contenues dans le storyboard fourni, avec l’état spécifié pour le contrôle de l’animation après son démarrage.

BeginStoryboard(Storyboard)

Commence la séquence d’actions contenues dans le storyboard fourni.

C#

public void BeginStoryboard (System.Windows.Media.Animation.Storyboard storyboard);

Paramètres

storyboard

Storyboard

Storyboard à commencer.

Exemples

L’exemple suivant récupère une Storyboard à partir de ressources, puis exécute cette Storyboard lorsqu’un événement interne est géré par une classe.

C#

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

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

Remarques

La plupart des scénarios d’animation classiques n’utilisent pas cette méthode. En règle générale, vous créez l’élément Storyboard ou BeginStoryboard dans le balisage, puis vous les placez comme contenu EventTrigger sur un élément. Lorsqu’elle est déclenchée par l’événement, l’animation s’exécute ensuite. La plupart des aspects de contrôle d’une Storyboard peuvent être traités par les propriétés exposées dans le balisage.

Pour les signatures qui n’utilisent pas le 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 « Remplissage ». Par conséquent, l’animation ne peut pas être redémarrée après l’exécution une seule fois. Le contrôle d’une animation nécessite également que le storyboard dispose d’une directive x :Name ou d’être accessible par référence dans le code.

BeginStoryboard(Storyboard, HandoffBehavior)

Commence la séquence d’actions contenues dans le storyboard fourni, avec des options spécifiées pour ce qui doit se produire si la propriété est déjà animée.

C#

public void BeginStoryboard (System.Windows.Media.Animation.Storyboard storyboard, System.Windows.Media.Animation.HandoffBehavior handoffBehavior);

Paramètres

storyboard

Storyboard

Storyboard à commencer.

handoffBehavior

HandoffBehavior

Valeur de l’énumération qui décrit le comportement à utiliser si une propriété décrite dans le storyboard est déjà animée.

Exemples

L’exemple suivant récupère une Storyboard à partir de ressources, puis exécute cette Storyboard lorsqu’un événement interne est géré par une classe.

C#

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

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

Remarques

La plupart des scénarios d’animation classiques n’utilisent pas cette méthode. En règle générale, vous créez l’élément Storyboard ou BeginStoryboard dans le balisage, puis vous les placez comme contenu EventTrigger sur un élément. Lorsqu’elle est déclenchée par l’événement, l’animation s’exécute ensuite. La plupart des aspects de contrôle d’une Storyboard peuvent être traités par les propriétés exposées dans le balisage.

Pour les signatures qui n’utilisent pas le 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 « Remplissage ». Par conséquent, l’animation ne peut pas être redémarrée après l’exécution une seule fois. Le contrôle d’une animation nécessite également que le storyboard dispose d’une directive x :Name ou d’être accessible par référence dans le code.

Le comportement de transfert peut être spécifié en tant qu’attribut de BeginStoryboard.

Utilisation de Compose HandoffBehavior

Lorsque vous appliquez un Storyboard, AnimationTimelineou AnimationClock à une propriété à l’aide de l'ComposeHandoffBehavior, 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.

Pour éviter les problèmes de performances lorsque vous appliquez un grand nombre d’horloges à l’aide de Compose, vous devez supprimer les horloges de composition de la propriété animée une fois qu’elles ont été terminées. Il existe plusieurs façons de supprimer une horloge :

• Pour supprimer toutes les horloges d’une propriété, utilisez la méthode ApplyAnimationClock(DependencyProperty, AnimationClock) ou BeginAnimation(DependencyProperty, AnimationTimeline) de l’objet animé. Spécifiez la propriété animée comme premier paramètre et null comme seconde. Cela supprime toutes les horloges d’animation de la propriété.

• Pour supprimer un AnimationClock spécifique d’une liste d’horloges, utilisez la propriété Controller de l'AnimationClock pour récupérer un ClockController, puis appelez la méthode Remove du ClockController. Cette opération est généralement effectuée dans le gestionnaire d’événements Completed pour une horloge. Notez que seules les horloges racines peuvent être contrôlées par un ClockController; la propriété Controller d’une horloge enfant retourne null. Notez également que l’événement Completed n’est pas déclenché si la durée effective de l’horloge est pour toujours. Dans ce cas, l’utilisateur doit déterminer quand appeler Remove.

Il s’agit principalement d’un problème pour les animations sur les objets qui ont une longue durée de vie. Lorsqu’un objet est récupéré par la mémoire, ses horloges sont également déconnectées et collectées par le garbage.

Pour plus d’informations sur les objets horloge, consultez Vue d’ensemble de l’animation et du système de minutage.

BeginStoryboard(Storyboard, HandoffBehavior, Boolean)

Commence la séquence d’actions contenues dans le storyboard fourni, avec l’état spécifié pour le contrôle de l’animation après son démarrage.

C#

public void BeginStoryboard (System.Windows.Media.Animation.Storyboard storyboard, System.Windows.Media.Animation.HandoffBehavior handoffBehavior, bool isControllable);

Paramètres

storyboard

Storyboard

Storyboard à commencer.

handoffBehavior

HandoffBehavior

Valeur de l’énumération qui décrit le comportement à utiliser si une propriété décrite dans le storyboard est déjà animée.

isControllable

Boolean

Déclare si l’animation peut être contrôlable (peut être suspendue) après son démarrage.

Remarques

La plupart des scénarios d’animation classiques n’utilisent pas cette méthode. En règle générale, vous créez l’élément Storyboard ou BeginStoryboard dans le balisage, puis vous les placez comme contenu EventTrigger sur un élément. Lorsqu’elle est déclenchée par l’événement, l’animation s’exécute ensuite. La plupart des aspects de contrôle d’une Storyboard peuvent être traités par les propriétés exposées dans le balisage.

Pour les signatures qui n’utilisent pas le 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 « Remplissage ». Par conséquent, l’animation ne peut pas être redémarrée après l’exécution une seule fois. Le contrôle d’une animation nécessite également que le storyboard dispose d’une directive x :Name ou d’être accessible par référence dans le code.

Le comportement de transfert peut être spécifié en tant qu’attribut de BeginStoryboard.

Utilisation de Compose HandoffBehavior

Lorsque vous appliquez un Storyboard, AnimationTimelineou AnimationClock à une propriété à l’aide de l'ComposeHandoffBehavior, 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.

Pour éviter les problèmes de performances lorsque vous appliquez un grand nombre d’horloges à l’aide de Compose, vous devez supprimer les horloges de composition de la propriété animée une fois qu’elles ont été terminées. Il existe plusieurs façons de supprimer une horloge :

• Pour supprimer toutes les horloges d’une propriété, utilisez la méthode ApplyAnimationClock(DependencyProperty, AnimationClock) ou BeginAnimation(DependencyProperty, AnimationTimeline) de l’objet animé. Spécifiez la propriété animée comme premier paramètre et null comme seconde. Cela supprime toutes les horloges d’animation de la propriété.

• Pour supprimer un AnimationClock spécifique d’une liste d’horloges, utilisez la propriété Controller de l'AnimationClock pour récupérer un ClockController, puis appelez la méthode Remove du ClockController. Cette opération est généralement effectuée dans le gestionnaire d’événements Completed pour une horloge. Notez que seules les horloges racines peuvent être contrôlées par un ClockController; la propriété Controller d’une horloge enfant retourne null. Notez également que l’événement Completed n’est pas déclenché si la durée effective de l’horloge est pour toujours. Dans ce cas, l’utilisateur doit déterminer quand appeler Remove.

Il s’agit principalement d’un problème pour les animations sur les objets qui ont une longue durée de vie. Lorsqu’un objet est récupéré par la mémoire, ses horloges sont également déconnectées et collectées par le garbage.

Pour plus d’informations sur les objets horloge, consultez Vue d’ensemble de l’animation et du système de minutage.