Storyboard.Begin Méthode
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Initialise le jeu d'animations associé à ce Storyboard.
Surcharges
Begin(FrameworkElement, FrameworkTemplate, HandoffBehavior, Boolean) |
Applique les animations associées avec ce Storyboard à leurs cibles dans le modèle spécifié et les initialise. |
Begin(FrameworkElement, HandoffBehavior, Boolean) |
Applique les animations associées à ce Storyboard à leurs cibles et les initialise. |
Begin(FrameworkElement, FrameworkTemplate, HandoffBehavior) |
Applique les animations associées avec ce Storyboard à leurs cibles dans le modèle spécifié et les initialise. |
Begin(FrameworkElement, FrameworkTemplate, Boolean) |
Applique les animations associées avec ce Storyboard à leurs cibles dans le modèle spécifié et les initialise. |
Begin(FrameworkContentElement, HandoffBehavior, Boolean) |
Applique les animations associées avec ce Storyboard à leurs cibles et les initialise à l'aide du HandoffBehavior spécifié. |
Begin(FrameworkElement, FrameworkTemplate) |
Applique les animations associées avec ce Storyboard à leurs cibles dans le modèle spécifié et les initialise. |
Begin(FrameworkElement, HandoffBehavior) |
Applique les animations associées avec ce Storyboard à leurs cibles et les initialise à l'aide du HandoffBehavior spécifié. |
Begin(FrameworkContentElement, HandoffBehavior) |
Applique les animations associées avec ce Storyboard à leurs cibles et les initialise à l'aide du HandoffBehavior spécifié. |
Begin(FrameworkContentElement, Boolean) |
Applique les animations associées à ce Storyboard à leurs cibles et les initialise. |
Begin(FrameworkElement) |
Applique les animations associées à ce Storyboard à leurs cibles et les initialise. |
Begin(FrameworkContentElement) |
Applique les animations associées à ce Storyboard à leurs cibles et les initialise. |
Begin() |
Applique les animations associées à ce Storyboard à leurs cibles et les initialise. |
Begin(FrameworkElement, Boolean) |
Applique les animations associées à ce Storyboard à leurs cibles et les initialise. |
Remarques
Un storyboard contrôlable peut suspendre, reprendre, rechercher, arrêter et être supprimé. Pour rendre un storyboard contrôlable dans le code, vous devez utiliser la surcharge appropriée de la méthode du Begin storyboard et spécifier true
pour la rendre contrôlable. Pour obtenir un exemple, consultez Guide pratique pour contrôler un storyboard après son démarrage.
Begin(FrameworkElement, FrameworkTemplate, HandoffBehavior, Boolean)
Applique les animations associées avec ce Storyboard à leurs cibles dans le modèle spécifié et les initialise.
public:
void Begin(System::Windows::FrameworkElement ^ containingObject, System::Windows::FrameworkTemplate ^ frameworkTemplate, System::Windows::Media::Animation::HandoffBehavior handoffBehavior, bool isControllable);
public void Begin (System.Windows.FrameworkElement containingObject, System.Windows.FrameworkTemplate frameworkTemplate, System.Windows.Media.Animation.HandoffBehavior handoffBehavior, bool isControllable);
member this.Begin : System.Windows.FrameworkElement * System.Windows.FrameworkTemplate * System.Windows.Media.Animation.HandoffBehavior * bool -> unit
Public Sub Begin (containingObject As FrameworkElement, frameworkTemplate As FrameworkTemplate, handoffBehavior As HandoffBehavior, isControllable As Boolean)
Paramètres
- containingObject
- FrameworkElement
Objet auquel le frameworkTemplate
spécifié a été appliqué. Les animations sans TargetName sont appliquées à containingObject
.
- frameworkTemplate
- FrameworkTemplate
Modèle à animer.
- handoffBehavior
- HandoffBehavior
Comportement que la nouvelle animation doit utiliser pour interagir avec toutes les animations actuelles.
- isControllable
- Boolean
true
si le plan conceptuel doit être contrôlable de façon interactive ; sinon, false
.
Remarques
Pour contrôler ce storyboard de manière interactive, vous devez spécifier la même containingObject
chose lors de l’appel des méthodes interactives que vous avez utilisées pour commencer le storyboard
Lorsque cette méthode est appelée, Clock des objets sont créés pour le storyboard et les chronologies qu’il contient. Ces horloges sont stockées avec containingObject
.
Le démarrage d’un storyboard déclenche les CurrentStateInvalidated événements et CurrentGlobalSpeedInvalidated .
Utilisation de Compose HandoffBehavior
Lorsque vous appliquez une Storyboardpropriété , AnimationTimelineou AnimationClock à une propriété à l’aide de , ComposeHandoffBehaviortous Clock les objets précédemment associés à cette propriété continuent à consommer des ressources système ; le système de minutage ne supprime pas ces horloges automatiquement.
Pour éviter les problèmes de performances lorsque vous appliquez un grand nombre d’horloges à l’aide Composede , vous devez supprimer les horloges de composition de la propriété animée une fois qu’elles sont terminées. Il existe plusieurs manières de supprimer une horloge.
Pour supprimer toutes les horloges d’une propriété, utilisez la ApplyAnimationClock(DependencyProperty, AnimationClock) méthode ou BeginAnimation(DependencyProperty, AnimationTimeline) de l’objet animé. Spécifiez la propriété animée comme premier paramètre et
null
comme deuxième. Cela supprime toutes les horloges d’animation de la propriété.Pour supprimer un spécifique AnimationClock d’une liste d’horloges, utilisez la Controller propriété de AnimationClock pour récupérer un ClockController, puis appelez la Remove méthode de ClockController. Cela se fait généralement dans le gestionnaire d’événements Completed d’une horloge. Notez que seules les horloges racines peuvent être contrôlées par un ClockController; la Controller propriété d’une horloge enfant retourne
null
. Notez également que l’événement Completed n’est pas appelé si la durée effective de l’horloge est éternelle. Dans ce cas, l’utilisateur doit déterminer quand appeler Remove.
Il s’agit principalement d’un problème pour les animations sur des objets qui ont une durée de vie longue. Lorsqu’un objet est collecté à la mémoire, ses horloges sont également déconnectées et ramassées.
Pour plus d’informations sur les objets d’horloge, consultez Animation et Vue d’ensemble du système de minutage.
S’applique à
Begin(FrameworkElement, HandoffBehavior, Boolean)
Applique les animations associées à ce Storyboard à leurs cibles et les initialise.
public:
void Begin(System::Windows::FrameworkElement ^ containingObject, System::Windows::Media::Animation::HandoffBehavior handoffBehavior, bool isControllable);
public void Begin (System.Windows.FrameworkElement containingObject, System.Windows.Media.Animation.HandoffBehavior handoffBehavior, bool isControllable);
member this.Begin : System.Windows.FrameworkElement * System.Windows.Media.Animation.HandoffBehavior * bool -> unit
Public Sub Begin (containingObject As FrameworkElement, handoffBehavior As HandoffBehavior, isControllable As Boolean)
Paramètres
- containingObject
- FrameworkElement
Objet contenu dans la même portée de nom que les cibles des animations de ce plan conceptuel. Les animations sans TargetName spécifié sont appliquées à containingObject
.
- handoffBehavior
- HandoffBehavior
Comportement que la nouvelle animation doit utiliser pour interagir avec toutes les animations actuelles.
- isControllable
- Boolean
Déclare si l'animation est contrôlable (peut être suspendue) une fois démarrée.
Exemples
L’exemple suivant montre comment créer un storyboard contrôlable.
using System;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Shapes;
using System.Windows.Media;
using System.Windows.Media.Animation;
namespace SDKSample
{
public class ControllableStoryboardExample : Page
{
private Storyboard myStoryboard;
public ControllableStoryboardExample()
{
// Create a name scope for the page.
NameScope.SetNameScope(this, new NameScope());
this.WindowTitle = "Controllable Storyboard Example";
StackPanel myStackPanel = new StackPanel();
myStackPanel.Margin = new Thickness(10);
// Create a rectangle.
Rectangle myRectangle = new Rectangle();
myRectangle.Name = "myRectangle";
// Assign the rectangle a name by
// registering it with the page, so that
// it can be targeted by storyboard
// animations.
this.RegisterName(myRectangle.Name, myRectangle);
myRectangle.Width = 100;
myRectangle.Height = 100;
myRectangle.Fill = Brushes.Blue;
myStackPanel.Children.Add(myRectangle);
//
// Create an animation and a storyboard to animate the
// rectangle.
//
DoubleAnimation myDoubleAnimation = new DoubleAnimation();
myDoubleAnimation.From = 1.0;
myDoubleAnimation.To = 0.0;
myDoubleAnimation.Duration = new Duration(TimeSpan.FromMilliseconds(5000));
myDoubleAnimation.AutoReverse = true;
// Create the storyboard.
myStoryboard = new Storyboard();
myStoryboard.Children.Add(myDoubleAnimation);
Storyboard.SetTargetName(myDoubleAnimation, myRectangle.Name);
Storyboard.SetTargetProperty(myDoubleAnimation, new PropertyPath(Rectangle.OpacityProperty));
//
// Create some buttons to control the storyboard
// and a panel to contain them.
//
StackPanel buttonPanel = new StackPanel();
buttonPanel.Orientation = Orientation.Horizontal;
Button beginButton = new Button();
beginButton.Content = "Begin";
beginButton.Click += new RoutedEventHandler(beginButton_Clicked);
buttonPanel.Children.Add(beginButton);
Button pauseButton = new Button();
pauseButton.Content = "Pause";
pauseButton.Click += new RoutedEventHandler(pauseButton_Clicked);
buttonPanel.Children.Add(pauseButton);
Button resumeButton = new Button();
resumeButton.Content = "Resume";
resumeButton.Click += new RoutedEventHandler(resumeButton_Clicked);
buttonPanel.Children.Add(resumeButton);
Button skipToFillButton = new Button();
skipToFillButton.Content = "Skip to Fill";
skipToFillButton.Click += new RoutedEventHandler(skipToFillButton_Clicked);
buttonPanel.Children.Add(skipToFillButton);
Button setSpeedRatioButton = new Button();
setSpeedRatioButton.Content = "Triple Speed";
setSpeedRatioButton.Click += new RoutedEventHandler(setSpeedRatioButton_Clicked);
buttonPanel.Children.Add(setSpeedRatioButton);
Button stopButton = new Button();
stopButton.Content = "Stop";
stopButton.Click += new RoutedEventHandler(stopButton_Clicked);
buttonPanel.Children.Add(stopButton);
myStackPanel.Children.Add(buttonPanel);
this.Content = myStackPanel;
}
// Begins the storyboard.
private void beginButton_Clicked(object sender, RoutedEventArgs args)
{
// Specifying "true" as the second Begin parameter
// makes this storyboard controllable.
myStoryboard.Begin(this, true);
}
// Pauses the storyboard.
private void pauseButton_Clicked(object sender, RoutedEventArgs args)
{
myStoryboard.Pause(this);
}
// Resumes the storyboard.
private void resumeButton_Clicked(object sender, RoutedEventArgs args)
{
myStoryboard.Resume(this);
}
// Advances the storyboard to its fill period.
private void skipToFillButton_Clicked(object sender, RoutedEventArgs args)
{
myStoryboard.SkipToFill(this);
}
// Updates the storyboard's speed.
private void setSpeedRatioButton_Clicked(object sender, RoutedEventArgs args)
{
// Makes the storyboard progress three times as fast as normal.
myStoryboard.SetSpeedRatio(this, 3);
}
// Stops the storyboard.
private void stopButton_Clicked(object sender, RoutedEventArgs args)
{
myStoryboard.Stop(this);
}
}
}
Imports System.Windows
Imports System.Windows.Controls
Imports System.Windows.Shapes
Imports System.Windows.Media
Imports System.Windows.Media.Animation
Namespace SDKSample
Public Class ControllableStoryboardExample
Inherits Page
Private myStoryboard As Storyboard
Public Sub New()
' Create a name scope for the page.
NameScope.SetNameScope(Me, New NameScope())
Me.WindowTitle = "Controllable Storyboard Example"
Dim myStackPanel As New StackPanel()
myStackPanel.Margin = New Thickness(10)
' Create a rectangle.
Dim myRectangle As New Rectangle()
myRectangle.Name = "myRectangle"
' Assign the rectangle a name by
' registering it with the page, so that
' it can be targeted by storyboard
' animations.
Me.RegisterName(myRectangle.Name, myRectangle)
myRectangle.Width = 100
myRectangle.Height = 100
myRectangle.Fill = Brushes.Blue
myStackPanel.Children.Add(myRectangle)
'
' Create an animation and a storyboard to animate the
' rectangle.
'
Dim myDoubleAnimation As New DoubleAnimation()
myDoubleAnimation.From = 1.0
myDoubleAnimation.To = 0.0
myDoubleAnimation.Duration = New Duration(TimeSpan.FromMilliseconds(5000))
myDoubleAnimation.AutoReverse = True
' Create the storyboard.
myStoryboard = New Storyboard()
myStoryboard.Children.Add(myDoubleAnimation)
Storyboard.SetTargetName(myDoubleAnimation, myRectangle.Name)
Storyboard.SetTargetProperty(myDoubleAnimation, New PropertyPath(Rectangle.OpacityProperty))
'
' Create some buttons to control the storyboard
' and a panel to contain them.
'
Dim buttonPanel As New StackPanel()
buttonPanel.Orientation = Orientation.Horizontal
Dim beginButton As New Button()
beginButton.Content = "Begin"
AddHandler beginButton.Click, AddressOf beginButton_Clicked
buttonPanel.Children.Add(beginButton)
Dim pauseButton As New Button()
pauseButton.Content = "Pause"
AddHandler pauseButton.Click, AddressOf pauseButton_Clicked
buttonPanel.Children.Add(pauseButton)
Dim resumeButton As New Button()
resumeButton.Content = "Resume"
AddHandler resumeButton.Click, AddressOf resumeButton_Clicked
buttonPanel.Children.Add(resumeButton)
Dim skipToFillButton As New Button()
skipToFillButton.Content = "Skip to Fill"
AddHandler skipToFillButton.Click, AddressOf skipToFillButton_Clicked
buttonPanel.Children.Add(skipToFillButton)
Dim setSpeedRatioButton As New Button()
setSpeedRatioButton.Content = "Triple Speed"
AddHandler setSpeedRatioButton.Click, AddressOf setSpeedRatioButton_Clicked
buttonPanel.Children.Add(setSpeedRatioButton)
Dim stopButton As New Button()
stopButton.Content = "Stop"
AddHandler stopButton.Click, AddressOf stopButton_Clicked
buttonPanel.Children.Add(stopButton)
myStackPanel.Children.Add(buttonPanel)
Me.Content = myStackPanel
End Sub
' Begins the storyboard.
Private Sub beginButton_Clicked(ByVal sender As Object, ByVal args As RoutedEventArgs)
' Specifying "true" as the second Begin parameter
' makes this storyboard controllable.
myStoryboard.Begin(Me, True)
End Sub
' Pauses the storyboard.
Private Sub pauseButton_Clicked(ByVal sender As Object, ByVal args As RoutedEventArgs)
myStoryboard.Pause(Me)
End Sub
' Resumes the storyboard.
Private Sub resumeButton_Clicked(ByVal sender As Object, ByVal args As RoutedEventArgs)
myStoryboard.Resume(Me)
End Sub
' Advances the storyboard to its fill period.
Private Sub skipToFillButton_Clicked(ByVal sender As Object, ByVal args As RoutedEventArgs)
myStoryboard.SkipToFill(Me)
End Sub
' Updates the storyboard's speed.
Private Sub setSpeedRatioButton_Clicked(ByVal sender As Object, ByVal args As RoutedEventArgs)
' Makes the storyboard progress three times as fast as normal.
myStoryboard.SetSpeedRatio(Me, 3)
End Sub
' Stops the storyboard.
Private Sub stopButton_Clicked(ByVal sender As Object, ByVal args As RoutedEventArgs)
myStoryboard.Stop(Me)
End Sub
End Class
End Namespace
L’exemple suivant utilise pour SnapshotAndReplaceHandoffBehavior animer lorsque l’utilisateur clique à gauche et lorsque ComposeHandoffBehavior l’utilisateur clique avec le bouton droit.
/*
This sample animates the position of an ellipse when
the user clicks within the main border. If the user
left-clicks, the SnapshotAndReplace HandoffBehavior
is used when applying the animations. If the user
right-clicks, the Compose HandoffBehavior is used
instead.
*/
using System;
using System.Windows;
using System.Windows.Navigation;
using System.Windows.Media;
using System.Windows.Media.Animation;
using System.Windows.Shapes;
using System.Windows.Controls;
using System.Windows.Input;
namespace Microsoft.Samples.Animation.AnimatingWithStoryboards
{
// Create the demonstration.
public class FrameworkElementStoryboardHandoffBehaviorExample : Page {
private Border containerBorder;
private Ellipse interactiveEllipse;
private Storyboard theStoryboard;
private DoubleAnimation xAnimation;
private DoubleAnimation yAnimation;
public FrameworkElementStoryboardHandoffBehaviorExample()
{
WindowTitle = "Interactive Animation Example";
// Create a name scope for the page.
NameScope.SetNameScope(this, new NameScope());
DockPanel myPanel = new DockPanel();
myPanel.Margin = new Thickness(20.0);
containerBorder = new Border();
containerBorder.Background = Brushes.White;
containerBorder.BorderBrush = Brushes.Black;
containerBorder.BorderThickness = new Thickness(2.0);
containerBorder.VerticalAlignment = VerticalAlignment.Stretch;
interactiveEllipse = new Ellipse();
interactiveEllipse.Fill = Brushes.Lime;
interactiveEllipse.Stroke = Brushes.Black;
interactiveEllipse.StrokeThickness = 2.0;
interactiveEllipse.Width = 25;
interactiveEllipse.Height = 25;
interactiveEllipse.HorizontalAlignment = HorizontalAlignment.Left;
interactiveEllipse.VerticalAlignment = VerticalAlignment.Top;
TranslateTransform interactiveTranslateTransform = new TranslateTransform();
this.RegisterName("InteractiveTranslateTransform", interactiveTranslateTransform);
interactiveEllipse.RenderTransform =
interactiveTranslateTransform;
xAnimation = new DoubleAnimation();
xAnimation.Duration = TimeSpan.FromSeconds(4);
yAnimation = xAnimation.Clone();
Storyboard.SetTargetName(xAnimation, "InteractiveTranslateTransform");
Storyboard.SetTargetProperty(xAnimation, new PropertyPath(TranslateTransform.XProperty));
Storyboard.SetTargetName(yAnimation, "InteractiveTranslateTransform");
Storyboard.SetTargetProperty(yAnimation, new PropertyPath(TranslateTransform.YProperty));
theStoryboard = new Storyboard();
theStoryboard.Children.Add(xAnimation);
theStoryboard.Children.Add(yAnimation);
containerBorder.MouseLeftButtonDown +=
new MouseButtonEventHandler(border_mouseLeftButtonDown);
containerBorder.MouseRightButtonDown +=
new MouseButtonEventHandler(border_mouseRightButtonDown);
containerBorder.Child = interactiveEllipse;
myPanel.Children.Add(containerBorder);
this.Content = myPanel;
}
// When the user left-clicks, use the
// SnapshotAndReplace HandoffBehavior when applying the animation.
private void border_mouseLeftButtonDown(object sender, MouseButtonEventArgs e)
{
Point clickPoint = Mouse.GetPosition(containerBorder);
// Set the target point so the center of the ellipse
// ends up at the clicked point.
Point targetPoint = new Point();
targetPoint.X = clickPoint.X - interactiveEllipse.Width / 2;
targetPoint.Y = clickPoint.Y - interactiveEllipse.Height / 2;
// Animate to the target point.
xAnimation.To = targetPoint.X;
yAnimation.To = targetPoint.Y;
theStoryboard.Begin(this, HandoffBehavior.SnapshotAndReplace);
// Change the color of the ellipse.
interactiveEllipse.Fill = Brushes.Lime;
}
// When the user right-clicks, use the
// Compose HandoffBehavior when applying the animation.
private void border_mouseRightButtonDown(object sender, MouseButtonEventArgs e)
{
// Find the point where the use clicked.
Point clickPoint = Mouse.GetPosition(containerBorder);
// Set the target point so the center of the ellipse
// ends up at the clicked point.
Point targetPoint = new Point();
targetPoint.X = clickPoint.X - interactiveEllipse.Width / 2;
targetPoint.Y = clickPoint.Y - interactiveEllipse.Height / 2;
// Animate to the target point.
xAnimation.To = targetPoint.X;
yAnimation.To = targetPoint.Y;
theStoryboard.Begin(this, HandoffBehavior.Compose);
// Change the color of the ellipse.
interactiveEllipse.Fill = Brushes.Orange;
}
}
}
'
'
' This sample animates the position of an ellipse when
' the user clicks within the main border. If the user
' left-clicks, the SnapshotAndReplace HandoffBehavior
' is used when applying the animations. If the user
' right-clicks, the Compose HandoffBehavior is used
' instead.
'
'
Imports System.Windows
Imports System.Windows.Navigation
Imports System.Windows.Media
Imports System.Windows.Media.Animation
Imports System.Windows.Shapes
Imports System.Windows.Controls
Imports System.Windows.Input
Namespace Microsoft.Samples.Animation.AnimatingWithStoryboards
' Create the demonstration.
Public Class FrameworkElementStoryboardHandoffBehaviorExample
Inherits Page
Private containerBorder As Border
Private interactiveEllipse As Ellipse
Private theStoryboard As Storyboard
Private xAnimation As DoubleAnimation
Private yAnimation As DoubleAnimation
Public Sub New()
WindowTitle = "Interactive Animation Example"
' Create a name scope for the page.
NameScope.SetNameScope(Me, New NameScope())
Dim myPanel As New DockPanel()
myPanel.Margin = New Thickness(20.0)
containerBorder = New Border()
containerBorder.Background = Brushes.White
containerBorder.BorderBrush = Brushes.Black
containerBorder.BorderThickness = New Thickness(2.0)
containerBorder.VerticalAlignment = VerticalAlignment.Stretch
interactiveEllipse = New Ellipse()
With interactiveEllipse
.Fill = Brushes.Lime
.Stroke = Brushes.Black
.StrokeThickness = 2.0
.Width = 25
.Height = 25
.HorizontalAlignment = HorizontalAlignment.Left
.VerticalAlignment = VerticalAlignment.Top
End With
Dim interactiveTranslateTransform As New TranslateTransform()
Me.RegisterName("InteractiveTranslateTransform", interactiveTranslateTransform)
interactiveEllipse.RenderTransform = interactiveTranslateTransform
xAnimation = New DoubleAnimation()
xAnimation.Duration = TimeSpan.FromSeconds(4)
yAnimation = xAnimation.Clone()
Storyboard.SetTargetName(xAnimation, "InteractiveTranslateTransform")
Storyboard.SetTargetProperty(xAnimation, New PropertyPath(TranslateTransform.XProperty))
Storyboard.SetTargetName(yAnimation, "InteractiveTranslateTransform")
Storyboard.SetTargetProperty(yAnimation, New PropertyPath(TranslateTransform.YProperty))
theStoryboard = New Storyboard()
theStoryboard.Children.Add(xAnimation)
theStoryboard.Children.Add(yAnimation)
AddHandler containerBorder.MouseLeftButtonDown, AddressOf border_mouseLeftButtonDown
AddHandler containerBorder.MouseRightButtonDown, AddressOf border_mouseRightButtonDown
containerBorder.Child = interactiveEllipse
myPanel.Children.Add(containerBorder)
Me.Content = myPanel
End Sub
' When the user left-clicks, use the
' SnapshotAndReplace HandoffBehavior when applying the animation.
Private Sub border_mouseLeftButtonDown(ByVal sender As Object, ByVal e As MouseButtonEventArgs)
Dim clickPoint As Point = Mouse.GetPosition(containerBorder)
' Set the target point so the center of the ellipse
' ends up at the clicked point.
Dim targetPoint As New Point()
targetPoint.X = clickPoint.X - interactiveEllipse.Width / 2
targetPoint.Y = clickPoint.Y - interactiveEllipse.Height / 2
' Animate to the target point.
xAnimation.To = targetPoint.X
yAnimation.To = targetPoint.Y
theStoryboard.Begin(Me, HandoffBehavior.SnapshotAndReplace)
' Change the color of the ellipse.
interactiveEllipse.Fill = Brushes.Lime
End Sub
' When the user right-clicks, use the
' Compose HandoffBehavior when applying the animation.
Private Sub border_mouseRightButtonDown(ByVal sender As Object, ByVal e As MouseButtonEventArgs)
' Find the point where the use clicked.
Dim clickPoint As Point = Mouse.GetPosition(containerBorder)
' Set the target point so the center of the ellipse
' ends up at the clicked point.
Dim targetPoint As New Point()
targetPoint.X = clickPoint.X - interactiveEllipse.Width / 2
targetPoint.Y = clickPoint.Y - interactiveEllipse.Height / 2
' Animate to the target point.
xAnimation.To = targetPoint.X
yAnimation.To = targetPoint.Y
theStoryboard.Begin(Me, HandoffBehavior.Compose)
' Change the color of the ellipse.
interactiveEllipse.Fill = Brushes.Orange
End Sub
End Class
End Namespace
Remarques
Pour contrôler de manière interactive ce storyboard, vous devez utiliser le même containingObject
paramètre lors de l’appel des méthodes interactives que vous avez utilisées pour commencer le storyboard
Lorsque cette méthode est appelée, Clock des objets sont créés pour le storyboard et les chronologies qu’il contient. Ces horloges sont stockées avec containingObject
.
Le démarrage d’un storyboard déclenche les CurrentStateInvalidated événements et CurrentGlobalSpeedInvalidated .
Utilisation de Compose HandoffBehavior
Lorsque vous appliquez une Storyboardpropriété , AnimationTimelineou AnimationClock à une propriété à l’aide de , ComposeHandoffBehaviortous Clock les objets précédemment associés à cette propriété continuent à consommer des ressources système ; le système de minutage ne supprime pas ces horloges automatiquement.
Pour éviter les problèmes de performances lorsque vous appliquez un grand nombre d’horloges à l’aide Composede , vous devez supprimer les horloges de composition de la propriété animée une fois qu’elles sont terminées. Il existe plusieurs manières de supprimer une horloge.
Pour supprimer toutes les horloges d’une propriété, utilisez la ApplyAnimationClock(DependencyProperty, AnimationClock) méthode ou BeginAnimation(DependencyProperty, AnimationTimeline) de l’objet animé. Spécifiez la propriété animée comme premier paramètre et
null
comme deuxième. Cela supprime toutes les horloges d’animation de la propriété.Pour supprimer un spécifique AnimationClock d’une liste d’horloges, utilisez la Controller propriété de AnimationClock pour récupérer un ClockController, puis appelez la Remove méthode de ClockController. Cela se fait généralement dans le gestionnaire d’événements Completed d’une horloge. Notez que seules les horloges racines peuvent être contrôlées par un ClockController; la Controller propriété d’une horloge enfant retourne
null
. Notez également que l’événement Completed n’est pas appelé si la durée effective de l’horloge est éternelle. Dans ce cas, l’utilisateur doit déterminer quand appeler Remove.
Il s’agit principalement d’un problème pour les animations sur des objets qui ont une durée de vie longue. Lorsqu’un objet est collecté à la mémoire, ses horloges sont également déconnectées et ramassées.
Pour plus d’informations sur les objets d’horloge, consultez Animation et Vue d’ensemble du système de minutage.
S’applique à
Begin(FrameworkElement, FrameworkTemplate, HandoffBehavior)
Applique les animations associées avec ce Storyboard à leurs cibles dans le modèle spécifié et les initialise.
public:
void Begin(System::Windows::FrameworkElement ^ containingObject, System::Windows::FrameworkTemplate ^ frameworkTemplate, System::Windows::Media::Animation::HandoffBehavior handoffBehavior);
public void Begin (System.Windows.FrameworkElement containingObject, System.Windows.FrameworkTemplate frameworkTemplate, System.Windows.Media.Animation.HandoffBehavior handoffBehavior);
member this.Begin : System.Windows.FrameworkElement * System.Windows.FrameworkTemplate * System.Windows.Media.Animation.HandoffBehavior -> unit
Public Sub Begin (containingObject As FrameworkElement, frameworkTemplate As FrameworkTemplate, handoffBehavior As HandoffBehavior)
Paramètres
- containingObject
- FrameworkElement
Objet auquel le frameworkTemplate
spécifié a été appliqué. Les animations sans TargetName sont appliquées à containingObject
.
- frameworkTemplate
- FrameworkTemplate
Modèle à animer.
- handoffBehavior
- HandoffBehavior
Comportement que la nouvelle animation doit utiliser pour interagir avec toutes les animations actuelles.
Remarques
Lorsque cette méthode est appelée, Clock des objets sont créés pour le storyboard et les chronologies qu’il contient. Ces horloges sont stockées avec containingObject
.
Le démarrage d’un storyboard déclenche les CurrentStateInvalidated événements et CurrentGlobalSpeedInvalidated .
Utilisation de Compose HandoffBehavior
Lorsque vous appliquez une Storyboardpropriété , AnimationTimelineou AnimationClock à une propriété à l’aide de , ComposeHandoffBehaviortous Clock les objets précédemment associés à cette propriété continuent à consommer des ressources système ; le système de minutage ne supprime pas ces horloges automatiquement.
Pour éviter les problèmes de performances lorsque vous appliquez un grand nombre d’horloges à l’aide Composede , vous devez supprimer les horloges de composition de la propriété animée une fois qu’elles sont terminées. Il existe plusieurs manières de supprimer une horloge.
Pour supprimer toutes les horloges d’une propriété, utilisez la ApplyAnimationClock(DependencyProperty, AnimationClock) méthode ou BeginAnimation(DependencyProperty, AnimationTimeline) de l’objet animé. Spécifiez la propriété animée comme premier paramètre et
null
comme deuxième. Cela supprime toutes les horloges d’animation de la propriété.Pour supprimer un spécifique AnimationClock d’une liste d’horloges, utilisez la Controller propriété de AnimationClock pour récupérer un ClockController, puis appelez la Remove méthode de ClockController. Cela se fait généralement dans le gestionnaire d’événements Completed d’une horloge. Notez que seules les horloges racines peuvent être contrôlées par un ClockController; la Controller propriété d’une horloge enfant retourne
null
. Notez également que l’événement Completed n’est pas appelé si la durée effective de l’horloge est éternelle. Dans ce cas, l’utilisateur doit déterminer quand appeler Remove.
Il s’agit principalement d’un problème pour les animations sur des objets qui ont une durée de vie longue. Lorsqu’un objet est récupéré par la mémoire, ses horloges sont également déconnectées et récupérées.
Pour plus d’informations sur les objets d’horloge, consultez Vue d’ensemble du système d’animation et de minutage.
S’applique à
Begin(FrameworkElement, FrameworkTemplate, Boolean)
Applique les animations associées avec ce Storyboard à leurs cibles dans le modèle spécifié et les initialise.
public:
void Begin(System::Windows::FrameworkElement ^ containingObject, System::Windows::FrameworkTemplate ^ frameworkTemplate, bool isControllable);
public void Begin (System.Windows.FrameworkElement containingObject, System.Windows.FrameworkTemplate frameworkTemplate, bool isControllable);
member this.Begin : System.Windows.FrameworkElement * System.Windows.FrameworkTemplate * bool -> unit
Public Sub Begin (containingObject As FrameworkElement, frameworkTemplate As FrameworkTemplate, isControllable As Boolean)
Paramètres
- containingObject
- FrameworkElement
Objet auquel le frameworkTemplate
spécifié a été appliqué. Les animations sans TargetName sont appliquées à containingObject
.
- frameworkTemplate
- FrameworkTemplate
Modèle à animer.
- isControllable
- Boolean
true
si le plan conceptuel doit être contrôlable de façon interactive ; sinon, false
.
Remarques
Si les propriétés ciblées sont déjà animées, elles sont remplacées à l’aide du comportement de SnapshotAndReplace transfert.
Pour contrôler de manière interactive ce storyboard, vous devez spécifier la même containingObject
chose lors de l’appel des méthodes interactives que vous avez utilisées pour commencer le storyboard
Lorsque cette méthode est appelée, Clock des objets sont créés pour le storyboard et toutes les chronologies qu’elle contient. Ces horloges sont stockées avec containingObject
.
Le démarrage d’une table de montage séquentiel déclenche les CurrentStateInvalidated événements et CurrentGlobalSpeedInvalidated .
S’applique à
Begin(FrameworkContentElement, HandoffBehavior, Boolean)
Applique les animations associées avec ce Storyboard à leurs cibles et les initialise à l'aide du HandoffBehavior spécifié.
public:
void Begin(System::Windows::FrameworkContentElement ^ containingObject, System::Windows::Media::Animation::HandoffBehavior handoffBehavior, bool isControllable);
public void Begin (System.Windows.FrameworkContentElement containingObject, System.Windows.Media.Animation.HandoffBehavior handoffBehavior, bool isControllable);
member this.Begin : System.Windows.FrameworkContentElement * System.Windows.Media.Animation.HandoffBehavior * bool -> unit
Public Sub Begin (containingObject As FrameworkContentElement, handoffBehavior As HandoffBehavior, isControllable As Boolean)
Paramètres
- containingObject
- FrameworkContentElement
Objet contenu dans la même portée de nom que les cibles des animations de ce plan conceptuel. Les animations sans TargetName spécifié sont appliquées à containingObject
.
- handoffBehavior
- HandoffBehavior
Comportement que la nouvelle animation doit utiliser pour interagir avec toutes les animations actuelles.
- isControllable
- Boolean
Déclare si l'animation est contrôlable (peut être suspendue) une fois démarrée.
Exemples
L’exemple suivant utilise un storyboard contrôlable pour animer un TextEffect. le TextEffect est contenu dans l’étendue d’un FrameworkContentElementnom de .
/*
This example shows how to control
a storyboard after it has started.
*/
using System;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Media;
using System.Windows.Shapes;
using System.Windows.Media.Animation;
using System.Windows.Documents;
namespace Microsoft.Samples.Animation.AnimatingWithStoryboards
{
public class FrameworkContentElementControlStoryboardExample : FlowDocument
{
private Storyboard myStoryboard;
public FrameworkContentElementControlStoryboardExample()
{
// Create a name scope for the document.
NameScope.SetNameScope(this, new NameScope());
this.Background = Brushes.White;
// Create a run of text.
Run theText = new Run(
"Lorem ipsum dolor sit amet, consectetuer adipiscing elit." +
"Ut non lacus. Nullam a ligula id leo adipiscing ornare." +
" Duis mattis. ");
// Create a TextEffect
TextEffect animatedSpecialEffect = new TextEffect();
animatedSpecialEffect.Foreground = Brushes.OrangeRed;
animatedSpecialEffect.PositionStart = 0;
animatedSpecialEffect.PositionCount = 0;
// Assign the TextEffect a name by
// registering it with the page, so that
// it can be targeted by storyboard
// animations
this.RegisterName("animatedSpecialEffect", animatedSpecialEffect);
// Apply the text effect to the run.
theText.TextEffects = new TextEffectCollection();
theText.TextEffects.Add(animatedSpecialEffect);
// Create a paragraph to contain the run.
Paragraph animatedParagraph = new Paragraph(theText);
animatedParagraph.Background = Brushes.LightGray;
animatedParagraph.Padding = new Thickness(20);
this.Blocks.Add(animatedParagraph);
BlockUIContainer controlsContainer = new BlockUIContainer();
//
// Create an animation and a storyboard to animate the
// text effect.
//
Int32Animation countAnimation =
new Int32Animation(0, 127, TimeSpan.FromSeconds(10));
Storyboard.SetTargetName(countAnimation, "animatedSpecialEffect");
Storyboard.SetTargetProperty(countAnimation,
new PropertyPath(TextEffect.PositionCountProperty));
myStoryboard = new Storyboard();
myStoryboard.Children.Add(countAnimation);
//
// Create some buttons to control the storyboard
// and a panel to contain them.
//
StackPanel buttonPanel = new StackPanel();
buttonPanel.Orientation = Orientation.Vertical;
Button beginButton = new Button();
beginButton.Content = "Begin";
beginButton.Click += new RoutedEventHandler(beginButton_Clicked);
buttonPanel.Children.Add(beginButton);
Button pauseButton = new Button();
pauseButton.Content = "Pause";
pauseButton.Click +=new RoutedEventHandler(pauseButton_Clicked);
buttonPanel.Children.Add(pauseButton);
Button resumeButton = new Button();
resumeButton.Content = "Resume";
resumeButton.Click +=new RoutedEventHandler(resumeButton_Clicked);
buttonPanel.Children.Add(resumeButton);
Button skipToFillButton = new Button();
skipToFillButton.Content = "Skip to Fill";
skipToFillButton.Click +=new RoutedEventHandler(skipToFillButton_Clicked);
buttonPanel.Children.Add(skipToFillButton);
Button setSpeedRatioButton = new Button();
setSpeedRatioButton.Content = "Triple Speed";
setSpeedRatioButton.Click +=new RoutedEventHandler(setSpeedRatioButton_Clicked);
buttonPanel.Children.Add(setSpeedRatioButton);
Button stopButton = new Button();
stopButton.Content = "Stop";
stopButton.Click +=new RoutedEventHandler(stopButton_Clicked);
buttonPanel.Children.Add(stopButton);
Button removeButton = new Button();
removeButton.Content = "Remove";
removeButton.Click +=new RoutedEventHandler(removeButton_Clicked);
buttonPanel.Children.Add(removeButton);
controlsContainer.Child = buttonPanel;
this.Blocks.Add(controlsContainer);
}
// Begins the storyboard.
private void beginButton_Clicked(object sender, RoutedEventArgs args)
{
// Specifying "true" as the second Begin parameter
// makes this storyboard controllable.
myStoryboard.Begin(this, true);
}
// Pauses the storyboard.
private void pauseButton_Clicked(object sender, RoutedEventArgs args)
{
myStoryboard.Pause(this);
}
// Resumes the storyboard.
private void resumeButton_Clicked(object sender, RoutedEventArgs args)
{
myStoryboard.Resume(this);
}
// Advances the storyboard to its fill period.
private void skipToFillButton_Clicked(object sender, RoutedEventArgs args)
{
myStoryboard.SkipToFill(this);
}
// Updates the storyboard's speed.
private void setSpeedRatioButton_Clicked(object sender, RoutedEventArgs args)
{
// Makes the storyboard progress three times as fast as normal.
myStoryboard.SetSpeedRatio(this, 3);
}
// Stops the storyboard.
private void stopButton_Clicked(object sender, RoutedEventArgs args)
{
myStoryboard.Stop(this);
}
// Removes the storyboard.
private void removeButton_Clicked(object sender, RoutedEventArgs args)
{
myStoryboard.Remove(this);
}
}
}
'
' This example shows how to control
' a storyboard after it has started.
'
'
Imports System.Windows
Imports System.Windows.Controls
Imports System.Windows.Media
Imports System.Windows.Shapes
Imports System.Windows.Media.Animation
Imports System.Windows.Documents
Namespace Microsoft.Samples.Animation.AnimatingWithStoryboards
Public Class FrameworkContentElementControlStoryboardExample
Inherits FlowDocument
Private myStoryboard As Storyboard
Public Sub New()
' Create a name scope for the document.
NameScope.SetNameScope(Me, New NameScope())
Me.Background = Brushes.White
' Create a run of text.
Dim theText As New Run("Lorem ipsum dolor sit amet, consectetuer adipiscing elit." & "Ut non lacus. Nullam a ligula id leo adipiscing ornare." & " Duis mattis. ")
' Create a TextEffect
Dim animatedSpecialEffect As New TextEffect()
animatedSpecialEffect.Foreground = Brushes.OrangeRed
animatedSpecialEffect.PositionStart = 0
animatedSpecialEffect.PositionCount = 0
' Assign the TextEffect a name by
' registering it with the page, so that
' it can be targeted by storyboard
' animations
Me.RegisterName("animatedSpecialEffect", animatedSpecialEffect)
' Apply the text effect to the run.
theText.TextEffects = New TextEffectCollection()
theText.TextEffects.Add(animatedSpecialEffect)
' Create a paragraph to contain the run.
Dim animatedParagraph As New Paragraph(theText)
animatedParagraph.Background = Brushes.LightGray
animatedParagraph.Padding = New Thickness(20)
Me.Blocks.Add(animatedParagraph)
Dim controlsContainer As New BlockUIContainer()
'
' Create an animation and a storyboard to animate the
' text effect.
'
Dim countAnimation As New Int32Animation(0, 127, TimeSpan.FromSeconds(10))
Storyboard.SetTargetName(countAnimation, "animatedSpecialEffect")
Storyboard.SetTargetProperty(countAnimation, New PropertyPath(TextEffect.PositionCountProperty))
myStoryboard = New Storyboard()
myStoryboard.Children.Add(countAnimation)
'
' Create some buttons to control the storyboard
' and a panel to contain them.
'
Dim buttonPanel As New StackPanel()
buttonPanel.Orientation = Orientation.Vertical
Dim beginButton As New Button()
beginButton.Content = "Begin"
AddHandler beginButton.Click, AddressOf beginButton_Clicked
buttonPanel.Children.Add(beginButton)
Dim pauseButton As New Button()
pauseButton.Content = "Pause"
AddHandler pauseButton.Click, AddressOf pauseButton_Clicked
buttonPanel.Children.Add(pauseButton)
Dim resumeButton As New Button()
resumeButton.Content = "Resume"
AddHandler resumeButton.Click, AddressOf resumeButton_Clicked
buttonPanel.Children.Add(resumeButton)
Dim skipToFillButton As New Button()
skipToFillButton.Content = "Skip to Fill"
AddHandler skipToFillButton.Click, AddressOf skipToFillButton_Clicked
buttonPanel.Children.Add(skipToFillButton)
Dim setSpeedRatioButton As New Button()
setSpeedRatioButton.Content = "Triple Speed"
AddHandler setSpeedRatioButton.Click, AddressOf setSpeedRatioButton_Clicked
buttonPanel.Children.Add(setSpeedRatioButton)
Dim stopButton As New Button()
stopButton.Content = "Stop"
AddHandler stopButton.Click, AddressOf stopButton_Clicked
buttonPanel.Children.Add(stopButton)
Dim removeButton As New Button()
removeButton.Content = "Remove"
AddHandler removeButton.Click, AddressOf removeButton_Clicked
buttonPanel.Children.Add(removeButton)
controlsContainer.Child = buttonPanel
Me.Blocks.Add(controlsContainer)
End Sub
' Begins the storyboard.
Private Sub beginButton_Clicked(ByVal sender As Object, ByVal args As RoutedEventArgs)
' Specifying "true" as the second Begin parameter
' makes this storyboard controllable.
myStoryboard.Begin(Me, True)
End Sub
' Pauses the storyboard.
Private Sub pauseButton_Clicked(ByVal sender As Object, ByVal args As RoutedEventArgs)
myStoryboard.Pause(Me)
End Sub
' Resumes the storyboard.
Private Sub resumeButton_Clicked(ByVal sender As Object, ByVal args As RoutedEventArgs)
myStoryboard.Resume(Me)
End Sub
' Advances the storyboard to its fill period.
Private Sub skipToFillButton_Clicked(ByVal sender As Object, ByVal args As RoutedEventArgs)
myStoryboard.SkipToFill(Me)
End Sub
' Updates the storyboard's speed.
Private Sub setSpeedRatioButton_Clicked(ByVal sender As Object, ByVal args As RoutedEventArgs)
' Makes the storyboard progress three times as fast as normal.
myStoryboard.SetSpeedRatio(Me, 3)
End Sub
' Stops the storyboard.
Private Sub stopButton_Clicked(ByVal sender As Object, ByVal args As RoutedEventArgs)
myStoryboard.Stop(Me)
End Sub
' Removes the storyboard.
Private Sub removeButton_Clicked(ByVal sender As Object, ByVal args As RoutedEventArgs)
myStoryboard.Remove(Me)
End Sub
End Class
End Namespace
L’exemple suivant utilise pour SnapshotAndReplaceHandoffBehavior animer lorsque l’utilisateur clique avec le bouton gauche, et lorsque ComposeHandoffBehavior l’utilisateur clique avec le bouton droit.
/*
This example shows how to animate
a FrameworkContentElement with a storyboard.
*/
using System;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Media;
using System.Windows.Shapes;
using System.Windows.Media.Animation;
using System.Windows.Documents;
using System.Windows.Input;
namespace Microsoft.Samples.Animation.AnimatingWithStoryboards
{
public class FrameworkContentElementStoryboardWithHandoffBehaviorExample :
FlowDocument
{
private Storyboard myStoryboard;
DoubleAnimation xAnimation;
DoubleAnimation yAnimation;
public FrameworkContentElementStoryboardWithHandoffBehaviorExample()
{
// Create a name scope for the document.
NameScope.SetNameScope(this, new NameScope());
this.Background = Brushes.Orange;
// Create a run of text.
Run theText = new Run(
"Lorem ipsum dolor sit amet, consectetuer adipiscing elit.");
// Create a TextEffect
TextEffect animatedSpecialEffect = new TextEffect();
animatedSpecialEffect.Foreground = Brushes.OrangeRed;
animatedSpecialEffect.PositionStart = 0;
animatedSpecialEffect.PositionCount = 20;
TranslateTransform animatedTransform =
new TranslateTransform();
// Assign the transform a name by
// registering it with the page, so that
// it can be targeted by storyboard
// animations.
this.RegisterName("animatedTransform", animatedTransform);
animatedSpecialEffect.Transform = animatedTransform;
// Apply the text effect to the run.
theText.TextEffects = new TextEffectCollection();
theText.TextEffects.Add(animatedSpecialEffect);
// Create a paragraph to contain the run.
Paragraph animatedParagraph = new Paragraph(theText);
animatedParagraph.Background = Brushes.LightGray;
this.Blocks.Add(animatedParagraph);
//
// Create a storyboard to animate the
// text effect's transform.
//
myStoryboard = new Storyboard();
xAnimation = new DoubleAnimation();
xAnimation.Duration = TimeSpan.FromSeconds(5);
Storyboard.SetTargetName(xAnimation, "animatedTransform");
Storyboard.SetTargetProperty(xAnimation,
new PropertyPath(TranslateTransform.XProperty));
myStoryboard.Children.Add(xAnimation);
yAnimation = new DoubleAnimation();
yAnimation.Duration = TimeSpan.FromSeconds(5);
Storyboard.SetTargetName(yAnimation, "animatedTransform");
Storyboard.SetTargetProperty(yAnimation,
new PropertyPath(TranslateTransform.YProperty));
myStoryboard.Children.Add(yAnimation);
this.MouseLeftButtonDown +=
new MouseButtonEventHandler(document_mouseLeftButtonDown);
this.MouseRightButtonDown +=
new MouseButtonEventHandler(document_mouseRightButtonDown);
}
// When the user left-clicks, use the
// SnapshotAndReplace HandoffBehavior when applying the animation.
private void document_mouseLeftButtonDown(object sender, MouseButtonEventArgs e)
{
Point clickPoint = Mouse.GetPosition(this);
// Animate to the target point.
xAnimation.To = clickPoint.X;
yAnimation.To = clickPoint.Y;
try
{
myStoryboard.Begin(this, HandoffBehavior.SnapshotAndReplace);
}catch(Exception ex)
{
MessageBox.Show(ex.ToString());
}
}
// When the user right-clicks, use the
// Compose HandoffBehavior when applying the animation.
private void document_mouseRightButtonDown(object sender, MouseButtonEventArgs e)
{
Point clickPoint = Mouse.GetPosition(this);
// Animate to the target point.
xAnimation.To = clickPoint.X;
yAnimation.To = clickPoint.Y;
myStoryboard.Begin(this, HandoffBehavior.Compose);
}
}
}
'
' This example shows how to animate
' a FrameworkContentElement with a storyboard.
'
'
Imports System.Windows
Imports System.Windows.Controls
Imports System.Windows.Media
Imports System.Windows.Shapes
Imports System.Windows.Media.Animation
Imports System.Windows.Documents
Imports System.Windows.Input
Namespace Microsoft.Samples.Animation.AnimatingWithStoryboards
Public Class FrameworkContentElementStoryboardWithHandoffBehaviorExample
Inherits FlowDocument
Private myStoryboard As Storyboard
Private xAnimation As DoubleAnimation
Private yAnimation As DoubleAnimation
Public Sub New()
' Create a name scope for the document.
NameScope.SetNameScope(Me, New NameScope())
Me.Background = Brushes.Orange
' Create a run of text.
Dim theText As New Run("Lorem ipsum dolor sit amet, consectetuer adipiscing elit.")
' Create a TextEffect
Dim animatedSpecialEffect As New TextEffect()
animatedSpecialEffect.Foreground = Brushes.OrangeRed
animatedSpecialEffect.PositionStart = 0
animatedSpecialEffect.PositionCount = 20
Dim animatedTransform As New TranslateTransform()
' Assign the transform a name by
' registering it with the page, so that
' it can be targeted by storyboard
' animations.
Me.RegisterName("animatedTransform", animatedTransform)
animatedSpecialEffect.Transform = animatedTransform
' Apply the text effect to the run.
theText.TextEffects = New TextEffectCollection()
theText.TextEffects.Add(animatedSpecialEffect)
' Create a paragraph to contain the run.
Dim animatedParagraph As New Paragraph(theText)
animatedParagraph.Background = Brushes.LightGray
Me.Blocks.Add(animatedParagraph)
'
' Create a storyboard to animate the
' text effect's transform.
'
myStoryboard = New Storyboard()
xAnimation = New DoubleAnimation()
xAnimation.Duration = TimeSpan.FromSeconds(5)
Storyboard.SetTargetName(xAnimation, "animatedTransform")
Storyboard.SetTargetProperty(xAnimation, New PropertyPath(TranslateTransform.XProperty))
myStoryboard.Children.Add(xAnimation)
yAnimation = New DoubleAnimation()
yAnimation.Duration = TimeSpan.FromSeconds(5)
Storyboard.SetTargetName(yAnimation, "animatedTransform")
Storyboard.SetTargetProperty(yAnimation, New PropertyPath(TranslateTransform.YProperty))
myStoryboard.Children.Add(yAnimation)
AddHandler MouseLeftButtonDown, AddressOf document_mouseLeftButtonDown
AddHandler MouseRightButtonDown, AddressOf document_mouseRightButtonDown
End Sub
' When the user left-clicks, use the
' SnapshotAndReplace HandoffBehavior when applying the animation.
Private Sub document_mouseLeftButtonDown(ByVal sender As Object, ByVal e As MouseButtonEventArgs)
Dim clickPoint As Point = Mouse.GetPosition(Me)
' Animate to the target point.
xAnimation.To = clickPoint.X
yAnimation.To = clickPoint.Y
Try
myStoryboard.Begin(Me, HandoffBehavior.SnapshotAndReplace)
Catch ex As Exception
MessageBox.Show(ex.ToString())
End Try
End Sub
' When the user right-clicks, use the
' Compose HandoffBehavior when applying the animation.
Private Sub document_mouseRightButtonDown(ByVal sender As Object, ByVal e As MouseButtonEventArgs)
Dim clickPoint As Point = Mouse.GetPosition(Me)
' Animate to the target point.
xAnimation.To = clickPoint.X
yAnimation.To = clickPoint.Y
myStoryboard.Begin(Me, HandoffBehavior.Compose)
End Sub
End Class
End Namespace
Remarques
Si les propriétés ciblées sont déjà animées, elles sont remplacées à l’aide du comportement de transfert spécifié.
Pour contrôler de manière interactive ce storyboard, vous devez spécifier la même containingObject
chose lors de l’appel des méthodes interactives que vous avez utilisées pour commencer le storyboard
Lorsque cette méthode est appelée, Clock des objets sont créés pour le storyboard et toutes les chronologies qu’elle contient. Ces horloges sont stockées avec containingObject
.
Le démarrage d’une table de montage séquentiel déclenche les CurrentStateInvalidated événements et CurrentGlobalSpeedInvalidated .
Utilisation de Compose HandoffBehavior
Lorsque vous appliquez un Storyboard, AnimationTimelineou AnimationClock à une propriété à l’aide de ComposeHandoffBehavior, les Clock objets précédemment associés à cette propriété continuent à consommer des ressources système ; le système de minutage ne supprime pas automatiquement ces horloges.
Pour éviter les problèmes de performances lorsque vous appliquez un grand nombre d’horloges à l’aide Composede , vous devez supprimer les horloges de composition de la propriété animée une fois qu’elles sont terminées. Il existe plusieurs manières de supprimer une horloge.
Pour supprimer toutes les horloges d’une propriété, utilisez la ApplyAnimationClock(DependencyProperty, AnimationClock) méthode ou BeginAnimation(DependencyProperty, AnimationTimeline) de l’objet animé. Spécifiez la propriété animée comme premier paramètre et
null
comme deuxième. Cela supprime toutes les horloges d’animation de la propriété .Pour supprimer un spécifique AnimationClock d’une liste d’horloges, utilisez la Controller propriété de AnimationClock pour récupérer un ClockController, puis appelez la Remove méthode du ClockController. Cette opération est généralement effectuée dans le gestionnaire d’événements Completed d’une horloge. Notez que seules les horloges racines peuvent être contrôlées par un ClockController; la Controller propriété d’une horloge enfant retourne
null
. Notez également que l’événement Completed n’est pas appelé si la durée effective de l’horloge est éternelle. Dans ce cas, l’utilisateur doit déterminer quand appeler Remove.
Il s’agit principalement d’un problème pour les animations sur des objets qui ont une durée de vie longue. Lorsqu’un objet est récupéré par la mémoire, ses horloges sont également déconnectées et récupérées.
Pour plus d’informations sur les objets d’horloge, consultez Vue d’ensemble du système d’animation et de minutage.
S’applique à
Begin(FrameworkElement, FrameworkTemplate)
Applique les animations associées avec ce Storyboard à leurs cibles dans le modèle spécifié et les initialise.
public:
void Begin(System::Windows::FrameworkElement ^ containingObject, System::Windows::FrameworkTemplate ^ frameworkTemplate);
public void Begin (System.Windows.FrameworkElement containingObject, System.Windows.FrameworkTemplate frameworkTemplate);
member this.Begin : System.Windows.FrameworkElement * System.Windows.FrameworkTemplate -> unit
Public Sub Begin (containingObject As FrameworkElement, frameworkTemplate As FrameworkTemplate)
Paramètres
- containingObject
- FrameworkElement
Objet auquel le frameworkTemplate
spécifié a été appliqué. Les animations sans TargetName sont appliquées à containingObject
.
- frameworkTemplate
- FrameworkTemplate
Modèle à animer.
Remarques
Si les propriétés ciblées sont déjà animées, elles sont remplacées à l’aide du comportement de SnapshotAndReplace transfert.
Lorsque cette méthode est appelée, Clock des objets sont créés pour le storyboard et toutes les chronologies qu’elle contient. Ces horloges sont stockées avec containingObject
.
Le démarrage d’une table de montage séquentiel déclenche les CurrentStateInvalidated événements et CurrentGlobalSpeedInvalidated .
S’applique à
Begin(FrameworkElement, HandoffBehavior)
Applique les animations associées avec ce Storyboard à leurs cibles et les initialise à l'aide du HandoffBehavior spécifié.
public:
void Begin(System::Windows::FrameworkElement ^ containingObject, System::Windows::Media::Animation::HandoffBehavior handoffBehavior);
public void Begin (System.Windows.FrameworkElement containingObject, System.Windows.Media.Animation.HandoffBehavior handoffBehavior);
member this.Begin : System.Windows.FrameworkElement * System.Windows.Media.Animation.HandoffBehavior -> unit
Public Sub Begin (containingObject As FrameworkElement, handoffBehavior As HandoffBehavior)
Paramètres
- containingObject
- FrameworkElement
Objet contenu dans la même portée de nom que les cibles des animations de ce plan conceptuel. Les animations sans TargetName spécifié sont appliquées à containingObject
.
- handoffBehavior
- HandoffBehavior
Comportement que la nouvelle animation doit utiliser pour interagir avec toutes les animations actuelles.
Exemples
L’exemple suivant utilise pour SnapshotAndReplaceHandoffBehavior animer lorsque l’utilisateur clique sur le bouton gauche, et lorsque ComposeHandoffBehavior l’utilisateur clique avec le bouton droit.
/*
This sample animates the position of an ellipse when
the user clicks within the main border. If the user
left-clicks, the SnapshotAndReplace HandoffBehavior
is used when applying the animations. If the user
right-clicks, the Compose HandoffBehavior is used
instead.
*/
using System;
using System.Windows;
using System.Windows.Navigation;
using System.Windows.Media;
using System.Windows.Media.Animation;
using System.Windows.Shapes;
using System.Windows.Controls;
using System.Windows.Input;
namespace Microsoft.Samples.Animation.AnimatingWithStoryboards
{
// Create the demonstration.
public class FrameworkElementStoryboardHandoffBehaviorExample : Page {
private Border containerBorder;
private Ellipse interactiveEllipse;
private Storyboard theStoryboard;
private DoubleAnimation xAnimation;
private DoubleAnimation yAnimation;
public FrameworkElementStoryboardHandoffBehaviorExample()
{
WindowTitle = "Interactive Animation Example";
// Create a name scope for the page.
NameScope.SetNameScope(this, new NameScope());
DockPanel myPanel = new DockPanel();
myPanel.Margin = new Thickness(20.0);
containerBorder = new Border();
containerBorder.Background = Brushes.White;
containerBorder.BorderBrush = Brushes.Black;
containerBorder.BorderThickness = new Thickness(2.0);
containerBorder.VerticalAlignment = VerticalAlignment.Stretch;
interactiveEllipse = new Ellipse();
interactiveEllipse.Fill = Brushes.Lime;
interactiveEllipse.Stroke = Brushes.Black;
interactiveEllipse.StrokeThickness = 2.0;
interactiveEllipse.Width = 25;
interactiveEllipse.Height = 25;
interactiveEllipse.HorizontalAlignment = HorizontalAlignment.Left;
interactiveEllipse.VerticalAlignment = VerticalAlignment.Top;
TranslateTransform interactiveTranslateTransform = new TranslateTransform();
this.RegisterName("InteractiveTranslateTransform", interactiveTranslateTransform);
interactiveEllipse.RenderTransform =
interactiveTranslateTransform;
xAnimation = new DoubleAnimation();
xAnimation.Duration = TimeSpan.FromSeconds(4);
yAnimation = xAnimation.Clone();
Storyboard.SetTargetName(xAnimation, "InteractiveTranslateTransform");
Storyboard.SetTargetProperty(xAnimation, new PropertyPath(TranslateTransform.XProperty));
Storyboard.SetTargetName(yAnimation, "InteractiveTranslateTransform");
Storyboard.SetTargetProperty(yAnimation, new PropertyPath(TranslateTransform.YProperty));
theStoryboard = new Storyboard();
theStoryboard.Children.Add(xAnimation);
theStoryboard.Children.Add(yAnimation);
containerBorder.MouseLeftButtonDown +=
new MouseButtonEventHandler(border_mouseLeftButtonDown);
containerBorder.MouseRightButtonDown +=
new MouseButtonEventHandler(border_mouseRightButtonDown);
containerBorder.Child = interactiveEllipse;
myPanel.Children.Add(containerBorder);
this.Content = myPanel;
}
// When the user left-clicks, use the
// SnapshotAndReplace HandoffBehavior when applying the animation.
private void border_mouseLeftButtonDown(object sender, MouseButtonEventArgs e)
{
Point clickPoint = Mouse.GetPosition(containerBorder);
// Set the target point so the center of the ellipse
// ends up at the clicked point.
Point targetPoint = new Point();
targetPoint.X = clickPoint.X - interactiveEllipse.Width / 2;
targetPoint.Y = clickPoint.Y - interactiveEllipse.Height / 2;
// Animate to the target point.
xAnimation.To = targetPoint.X;
yAnimation.To = targetPoint.Y;
theStoryboard.Begin(this, HandoffBehavior.SnapshotAndReplace);
// Change the color of the ellipse.
interactiveEllipse.Fill = Brushes.Lime;
}
// When the user right-clicks, use the
// Compose HandoffBehavior when applying the animation.
private void border_mouseRightButtonDown(object sender, MouseButtonEventArgs e)
{
// Find the point where the use clicked.
Point clickPoint = Mouse.GetPosition(containerBorder);
// Set the target point so the center of the ellipse
// ends up at the clicked point.
Point targetPoint = new Point();
targetPoint.X = clickPoint.X - interactiveEllipse.Width / 2;
targetPoint.Y = clickPoint.Y - interactiveEllipse.Height / 2;
// Animate to the target point.
xAnimation.To = targetPoint.X;
yAnimation.To = targetPoint.Y;
theStoryboard.Begin(this, HandoffBehavior.Compose);
// Change the color of the ellipse.
interactiveEllipse.Fill = Brushes.Orange;
}
}
}
'
'
' This sample animates the position of an ellipse when
' the user clicks within the main border. If the user
' left-clicks, the SnapshotAndReplace HandoffBehavior
' is used when applying the animations. If the user
' right-clicks, the Compose HandoffBehavior is used
' instead.
'
'
Imports System.Windows
Imports System.Windows.Navigation
Imports System.Windows.Media
Imports System.Windows.Media.Animation
Imports System.Windows.Shapes
Imports System.Windows.Controls
Imports System.Windows.Input
Namespace Microsoft.Samples.Animation.AnimatingWithStoryboards
' Create the demonstration.
Public Class FrameworkElementStoryboardHandoffBehaviorExample
Inherits Page
Private containerBorder As Border
Private interactiveEllipse As Ellipse
Private theStoryboard As Storyboard
Private xAnimation As DoubleAnimation
Private yAnimation As DoubleAnimation
Public Sub New()
WindowTitle = "Interactive Animation Example"
' Create a name scope for the page.
NameScope.SetNameScope(Me, New NameScope())
Dim myPanel As New DockPanel()
myPanel.Margin = New Thickness(20.0)
containerBorder = New Border()
containerBorder.Background = Brushes.White
containerBorder.BorderBrush = Brushes.Black
containerBorder.BorderThickness = New Thickness(2.0)
containerBorder.VerticalAlignment = VerticalAlignment.Stretch
interactiveEllipse = New Ellipse()
With interactiveEllipse
.Fill = Brushes.Lime
.Stroke = Brushes.Black
.StrokeThickness = 2.0
.Width = 25
.Height = 25
.HorizontalAlignment = HorizontalAlignment.Left
.VerticalAlignment = VerticalAlignment.Top
End With
Dim interactiveTranslateTransform As New TranslateTransform()
Me.RegisterName("InteractiveTranslateTransform", interactiveTranslateTransform)
interactiveEllipse.RenderTransform = interactiveTranslateTransform
xAnimation = New DoubleAnimation()
xAnimation.Duration = TimeSpan.FromSeconds(4)
yAnimation = xAnimation.Clone()
Storyboard.SetTargetName(xAnimation, "InteractiveTranslateTransform")
Storyboard.SetTargetProperty(xAnimation, New PropertyPath(TranslateTransform.XProperty))
Storyboard.SetTargetName(yAnimation, "InteractiveTranslateTransform")
Storyboard.SetTargetProperty(yAnimation, New PropertyPath(TranslateTransform.YProperty))
theStoryboard = New Storyboard()
theStoryboard.Children.Add(xAnimation)
theStoryboard.Children.Add(yAnimation)
AddHandler containerBorder.MouseLeftButtonDown, AddressOf border_mouseLeftButtonDown
AddHandler containerBorder.MouseRightButtonDown, AddressOf border_mouseRightButtonDown
containerBorder.Child = interactiveEllipse
myPanel.Children.Add(containerBorder)
Me.Content = myPanel
End Sub
' When the user left-clicks, use the
' SnapshotAndReplace HandoffBehavior when applying the animation.
Private Sub border_mouseLeftButtonDown(ByVal sender As Object, ByVal e As MouseButtonEventArgs)
Dim clickPoint As Point = Mouse.GetPosition(containerBorder)
' Set the target point so the center of the ellipse
' ends up at the clicked point.
Dim targetPoint As New Point()
targetPoint.X = clickPoint.X - interactiveEllipse.Width / 2
targetPoint.Y = clickPoint.Y - interactiveEllipse.Height / 2
' Animate to the target point.
xAnimation.To = targetPoint.X
yAnimation.To = targetPoint.Y
theStoryboard.Begin(Me, HandoffBehavior.SnapshotAndReplace)
' Change the color of the ellipse.
interactiveEllipse.Fill = Brushes.Lime
End Sub
' When the user right-clicks, use the
' Compose HandoffBehavior when applying the animation.
Private Sub border_mouseRightButtonDown(ByVal sender As Object, ByVal e As MouseButtonEventArgs)
' Find the point where the use clicked.
Dim clickPoint As Point = Mouse.GetPosition(containerBorder)
' Set the target point so the center of the ellipse
' ends up at the clicked point.
Dim targetPoint As New Point()
targetPoint.X = clickPoint.X - interactiveEllipse.Width / 2
targetPoint.Y = clickPoint.Y - interactiveEllipse.Height / 2
' Animate to the target point.
xAnimation.To = targetPoint.X
yAnimation.To = targetPoint.Y
theStoryboard.Begin(Me, HandoffBehavior.Compose)
' Change the color of the ellipse.
interactiveEllipse.Fill = Brushes.Orange
End Sub
End Class
End Namespace
S’applique à
Begin(FrameworkContentElement, HandoffBehavior)
Applique les animations associées avec ce Storyboard à leurs cibles et les initialise à l'aide du HandoffBehavior spécifié.
public:
void Begin(System::Windows::FrameworkContentElement ^ containingObject, System::Windows::Media::Animation::HandoffBehavior handoffBehavior);
public void Begin (System.Windows.FrameworkContentElement containingObject, System.Windows.Media.Animation.HandoffBehavior handoffBehavior);
member this.Begin : System.Windows.FrameworkContentElement * System.Windows.Media.Animation.HandoffBehavior -> unit
Public Sub Begin (containingObject As FrameworkContentElement, handoffBehavior As HandoffBehavior)
Paramètres
- containingObject
- FrameworkContentElement
Objet contenu dans la même portée de nom que les cibles des animations de ce plan conceptuel. Les animations sans TargetName sont appliquées à containingObject
.
- handoffBehavior
- HandoffBehavior
Comportement que la nouvelle animation doit utiliser pour interagir avec toutes les animations actuelles.
Exemples
L’exemple suivant utilise pour SnapshotAndReplaceHandoffBehavior animer lorsque l’utilisateur clique sur le bouton gauche, et lorsque ComposeHandoffBehavior l’utilisateur clique avec le bouton droit.
/*
This example shows how to animate
a FrameworkContentElement with a storyboard.
*/
using System;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Media;
using System.Windows.Shapes;
using System.Windows.Media.Animation;
using System.Windows.Documents;
using System.Windows.Input;
namespace Microsoft.Samples.Animation.AnimatingWithStoryboards
{
public class FrameworkContentElementStoryboardWithHandoffBehaviorExample :
FlowDocument
{
private Storyboard myStoryboard;
DoubleAnimation xAnimation;
DoubleAnimation yAnimation;
public FrameworkContentElementStoryboardWithHandoffBehaviorExample()
{
// Create a name scope for the document.
NameScope.SetNameScope(this, new NameScope());
this.Background = Brushes.Orange;
// Create a run of text.
Run theText = new Run(
"Lorem ipsum dolor sit amet, consectetuer adipiscing elit.");
// Create a TextEffect
TextEffect animatedSpecialEffect = new TextEffect();
animatedSpecialEffect.Foreground = Brushes.OrangeRed;
animatedSpecialEffect.PositionStart = 0;
animatedSpecialEffect.PositionCount = 20;
TranslateTransform animatedTransform =
new TranslateTransform();
// Assign the transform a name by
// registering it with the page, so that
// it can be targeted by storyboard
// animations.
this.RegisterName("animatedTransform", animatedTransform);
animatedSpecialEffect.Transform = animatedTransform;
// Apply the text effect to the run.
theText.TextEffects = new TextEffectCollection();
theText.TextEffects.Add(animatedSpecialEffect);
// Create a paragraph to contain the run.
Paragraph animatedParagraph = new Paragraph(theText);
animatedParagraph.Background = Brushes.LightGray;
this.Blocks.Add(animatedParagraph);
//
// Create a storyboard to animate the
// text effect's transform.
//
myStoryboard = new Storyboard();
xAnimation = new DoubleAnimation();
xAnimation.Duration = TimeSpan.FromSeconds(5);
Storyboard.SetTargetName(xAnimation, "animatedTransform");
Storyboard.SetTargetProperty(xAnimation,
new PropertyPath(TranslateTransform.XProperty));
myStoryboard.Children.Add(xAnimation);
yAnimation = new DoubleAnimation();
yAnimation.Duration = TimeSpan.FromSeconds(5);
Storyboard.SetTargetName(yAnimation, "animatedTransform");
Storyboard.SetTargetProperty(yAnimation,
new PropertyPath(TranslateTransform.YProperty));
myStoryboard.Children.Add(yAnimation);
this.MouseLeftButtonDown +=
new MouseButtonEventHandler(document_mouseLeftButtonDown);
this.MouseRightButtonDown +=
new MouseButtonEventHandler(document_mouseRightButtonDown);
}
// When the user left-clicks, use the
// SnapshotAndReplace HandoffBehavior when applying the animation.
private void document_mouseLeftButtonDown(object sender, MouseButtonEventArgs e)
{
Point clickPoint = Mouse.GetPosition(this);
// Animate to the target point.
xAnimation.To = clickPoint.X;
yAnimation.To = clickPoint.Y;
try
{
myStoryboard.Begin(this, HandoffBehavior.SnapshotAndReplace);
}catch(Exception ex)
{
MessageBox.Show(ex.ToString());
}
}
// When the user right-clicks, use the
// Compose HandoffBehavior when applying the animation.
private void document_mouseRightButtonDown(object sender, MouseButtonEventArgs e)
{
Point clickPoint = Mouse.GetPosition(this);
// Animate to the target point.
xAnimation.To = clickPoint.X;
yAnimation.To = clickPoint.Y;
myStoryboard.Begin(this, HandoffBehavior.Compose);
}
}
}
'
' This example shows how to animate
' a FrameworkContentElement with a storyboard.
'
'
Imports System.Windows
Imports System.Windows.Controls
Imports System.Windows.Media
Imports System.Windows.Shapes
Imports System.Windows.Media.Animation
Imports System.Windows.Documents
Imports System.Windows.Input
Namespace Microsoft.Samples.Animation.AnimatingWithStoryboards
Public Class FrameworkContentElementStoryboardWithHandoffBehaviorExample
Inherits FlowDocument
Private myStoryboard As Storyboard
Private xAnimation As DoubleAnimation
Private yAnimation As DoubleAnimation
Public Sub New()
' Create a name scope for the document.
NameScope.SetNameScope(Me, New NameScope())
Me.Background = Brushes.Orange
' Create a run of text.
Dim theText As New Run("Lorem ipsum dolor sit amet, consectetuer adipiscing elit.")
' Create a TextEffect
Dim animatedSpecialEffect As New TextEffect()
animatedSpecialEffect.Foreground = Brushes.OrangeRed
animatedSpecialEffect.PositionStart = 0
animatedSpecialEffect.PositionCount = 20
Dim animatedTransform As New TranslateTransform()
' Assign the transform a name by
' registering it with the page, so that
' it can be targeted by storyboard
' animations.
Me.RegisterName("animatedTransform", animatedTransform)
animatedSpecialEffect.Transform = animatedTransform
' Apply the text effect to the run.
theText.TextEffects = New TextEffectCollection()
theText.TextEffects.Add(animatedSpecialEffect)
' Create a paragraph to contain the run.
Dim animatedParagraph As New Paragraph(theText)
animatedParagraph.Background = Brushes.LightGray
Me.Blocks.Add(animatedParagraph)
'
' Create a storyboard to animate the
' text effect's transform.
'
myStoryboard = New Storyboard()
xAnimation = New DoubleAnimation()
xAnimation.Duration = TimeSpan.FromSeconds(5)
Storyboard.SetTargetName(xAnimation, "animatedTransform")
Storyboard.SetTargetProperty(xAnimation, New PropertyPath(TranslateTransform.XProperty))
myStoryboard.Children.Add(xAnimation)
yAnimation = New DoubleAnimation()
yAnimation.Duration = TimeSpan.FromSeconds(5)
Storyboard.SetTargetName(yAnimation, "animatedTransform")
Storyboard.SetTargetProperty(yAnimation, New PropertyPath(TranslateTransform.YProperty))
myStoryboard.Children.Add(yAnimation)
AddHandler MouseLeftButtonDown, AddressOf document_mouseLeftButtonDown
AddHandler MouseRightButtonDown, AddressOf document_mouseRightButtonDown
End Sub
' When the user left-clicks, use the
' SnapshotAndReplace HandoffBehavior when applying the animation.
Private Sub document_mouseLeftButtonDown(ByVal sender As Object, ByVal e As MouseButtonEventArgs)
Dim clickPoint As Point = Mouse.GetPosition(Me)
' Animate to the target point.
xAnimation.To = clickPoint.X
yAnimation.To = clickPoint.Y
Try
myStoryboard.Begin(Me, HandoffBehavior.SnapshotAndReplace)
Catch ex As Exception
MessageBox.Show(ex.ToString())
End Try
End Sub
' When the user right-clicks, use the
' Compose HandoffBehavior when applying the animation.
Private Sub document_mouseRightButtonDown(ByVal sender As Object, ByVal e As MouseButtonEventArgs)
Dim clickPoint As Point = Mouse.GetPosition(Me)
' Animate to the target point.
xAnimation.To = clickPoint.X
yAnimation.To = clickPoint.Y
myStoryboard.Begin(Me, HandoffBehavior.Compose)
End Sub
End Class
End Namespace
Remarques
Lorsque vous appliquez un Storyboard, AnimationTimelineou AnimationClock à une propriété à l’aide de ComposeHandoffBehavior, les Clock objets précédemment associés à cette propriété continuent à consommer des ressources système ; le système de minutage ne supprime pas automatiquement ces horloges.
Pour éviter les problèmes de performances lorsque vous appliquez un grand nombre d’horloges à l’aide Composede , vous devez supprimer les horloges de composition de la propriété animée une fois qu’elles sont terminées. Il existe plusieurs manières de supprimer une horloge.
Pour supprimer toutes les horloges d’une propriété, utilisez la ApplyAnimationClock(DependencyProperty, AnimationClock) méthode ou BeginAnimation(DependencyProperty, AnimationTimeline) de l’objet animé. Spécifiez la propriété animée comme premier paramètre et
null
comme deuxième. Cela supprime toutes les horloges d’animation de la propriété .Pour supprimer un spécifique AnimationClock d’une liste d’horloges, utilisez la Controller propriété de AnimationClock pour récupérer un ClockController, puis appelez la Remove méthode du ClockController. Cette opération est généralement effectuée dans le gestionnaire d’événements Completed d’une horloge. Notez que seules les horloges racines peuvent être contrôlées par un ClockController; la Controller propriété d’une horloge enfant retourne
null
. Notez également que l’événement Completed n’est pas appelé si la durée effective de l’horloge est éternelle. Dans ce cas, l’utilisateur doit déterminer quand appeler Remove.
Il s’agit principalement d’un problème pour les animations sur des objets qui ont une durée de vie longue. Lorsqu’un objet est récupéré par la mémoire, ses horloges sont également déconnectées et récupérées.
Pour plus d’informations sur les objets d’horloge, consultez Vue d’ensemble du système d’animation et de minutage.
S’applique à
Begin(FrameworkContentElement, Boolean)
Applique les animations associées à ce Storyboard à leurs cibles et les initialise.
public:
void Begin(System::Windows::FrameworkContentElement ^ containingObject, bool isControllable);
public void Begin (System.Windows.FrameworkContentElement containingObject, bool isControllable);
member this.Begin : System.Windows.FrameworkContentElement * bool -> unit
Public Sub Begin (containingObject As FrameworkContentElement, isControllable As Boolean)
Paramètres
- containingObject
- FrameworkContentElement
Objet contenu dans la même portée de nom que les cibles des animations de ce plan conceptuel. Les animations sans TargetName sont appliquées à containingObject
.
- isControllable
- Boolean
true
si le plan conceptuel doit être contrôlable de façon interactive ; sinon, false
.
Exemples
L’exemple suivant utilise un storyboard contrôlable pour animer un TextEffect. le TextEffect est contenu dans l’étendue d’un FrameworkContentElementnom de .
/*
This example shows how to control
a storyboard after it has started.
*/
using System;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Media;
using System.Windows.Shapes;
using System.Windows.Media.Animation;
using System.Windows.Documents;
namespace Microsoft.Samples.Animation.AnimatingWithStoryboards
{
public class FrameworkContentElementControlStoryboardExample : FlowDocument
{
private Storyboard myStoryboard;
public FrameworkContentElementControlStoryboardExample()
{
// Create a name scope for the document.
NameScope.SetNameScope(this, new NameScope());
this.Background = Brushes.White;
// Create a run of text.
Run theText = new Run(
"Lorem ipsum dolor sit amet, consectetuer adipiscing elit." +
"Ut non lacus. Nullam a ligula id leo adipiscing ornare." +
" Duis mattis. ");
// Create a TextEffect
TextEffect animatedSpecialEffect = new TextEffect();
animatedSpecialEffect.Foreground = Brushes.OrangeRed;
animatedSpecialEffect.PositionStart = 0;
animatedSpecialEffect.PositionCount = 0;
// Assign the TextEffect a name by
// registering it with the page, so that
// it can be targeted by storyboard
// animations
this.RegisterName("animatedSpecialEffect", animatedSpecialEffect);
// Apply the text effect to the run.
theText.TextEffects = new TextEffectCollection();
theText.TextEffects.Add(animatedSpecialEffect);
// Create a paragraph to contain the run.
Paragraph animatedParagraph = new Paragraph(theText);
animatedParagraph.Background = Brushes.LightGray;
animatedParagraph.Padding = new Thickness(20);
this.Blocks.Add(animatedParagraph);
BlockUIContainer controlsContainer = new BlockUIContainer();
//
// Create an animation and a storyboard to animate the
// text effect.
//
Int32Animation countAnimation =
new Int32Animation(0, 127, TimeSpan.FromSeconds(10));
Storyboard.SetTargetName(countAnimation, "animatedSpecialEffect");
Storyboard.SetTargetProperty(countAnimation,
new PropertyPath(TextEffect.PositionCountProperty));
myStoryboard = new Storyboard();
myStoryboard.Children.Add(countAnimation);
//
// Create some buttons to control the storyboard
// and a panel to contain them.
//
StackPanel buttonPanel = new StackPanel();
buttonPanel.Orientation = Orientation.Vertical;
Button beginButton = new Button();
beginButton.Content = "Begin";
beginButton.Click += new RoutedEventHandler(beginButton_Clicked);
buttonPanel.Children.Add(beginButton);
Button pauseButton = new Button();
pauseButton.Content = "Pause";
pauseButton.Click +=new RoutedEventHandler(pauseButton_Clicked);
buttonPanel.Children.Add(pauseButton);
Button resumeButton = new Button();
resumeButton.Content = "Resume";
resumeButton.Click +=new RoutedEventHandler(resumeButton_Clicked);
buttonPanel.Children.Add(resumeButton);
Button skipToFillButton = new Button();
skipToFillButton.Content = "Skip to Fill";
skipToFillButton.Click +=new RoutedEventHandler(skipToFillButton_Clicked);
buttonPanel.Children.Add(skipToFillButton);
Button setSpeedRatioButton = new Button();
setSpeedRatioButton.Content = "Triple Speed";
setSpeedRatioButton.Click +=new RoutedEventHandler(setSpeedRatioButton_Clicked);
buttonPanel.Children.Add(setSpeedRatioButton);
Button stopButton = new Button();
stopButton.Content = "Stop";
stopButton.Click +=new RoutedEventHandler(stopButton_Clicked);
buttonPanel.Children.Add(stopButton);
Button removeButton = new Button();
removeButton.Content = "Remove";
removeButton.Click +=new RoutedEventHandler(removeButton_Clicked);
buttonPanel.Children.Add(removeButton);
controlsContainer.Child = buttonPanel;
this.Blocks.Add(controlsContainer);
}
// Begins the storyboard.
private void beginButton_Clicked(object sender, RoutedEventArgs args)
{
// Specifying "true" as the second Begin parameter
// makes this storyboard controllable.
myStoryboard.Begin(this, true);
}
// Pauses the storyboard.
private void pauseButton_Clicked(object sender, RoutedEventArgs args)
{
myStoryboard.Pause(this);
}
// Resumes the storyboard.
private void resumeButton_Clicked(object sender, RoutedEventArgs args)
{
myStoryboard.Resume(this);
}
// Advances the storyboard to its fill period.
private void skipToFillButton_Clicked(object sender, RoutedEventArgs args)
{
myStoryboard.SkipToFill(this);
}
// Updates the storyboard's speed.
private void setSpeedRatioButton_Clicked(object sender, RoutedEventArgs args)
{
// Makes the storyboard progress three times as fast as normal.
myStoryboard.SetSpeedRatio(this, 3);
}
// Stops the storyboard.
private void stopButton_Clicked(object sender, RoutedEventArgs args)
{
myStoryboard.Stop(this);
}
// Removes the storyboard.
private void removeButton_Clicked(object sender, RoutedEventArgs args)
{
myStoryboard.Remove(this);
}
}
}
'
' This example shows how to control
' a storyboard after it has started.
'
'
Imports System.Windows
Imports System.Windows.Controls
Imports System.Windows.Media
Imports System.Windows.Shapes
Imports System.Windows.Media.Animation
Imports System.Windows.Documents
Namespace Microsoft.Samples.Animation.AnimatingWithStoryboards
Public Class FrameworkContentElementControlStoryboardExample
Inherits FlowDocument
Private myStoryboard As Storyboard
Public Sub New()
' Create a name scope for the document.
NameScope.SetNameScope(Me, New NameScope())
Me.Background = Brushes.White
' Create a run of text.
Dim theText As New Run("Lorem ipsum dolor sit amet, consectetuer adipiscing elit." & "Ut non lacus. Nullam a ligula id leo adipiscing ornare." & " Duis mattis. ")
' Create a TextEffect
Dim animatedSpecialEffect As New TextEffect()
animatedSpecialEffect.Foreground = Brushes.OrangeRed
animatedSpecialEffect.PositionStart = 0
animatedSpecialEffect.PositionCount = 0
' Assign the TextEffect a name by
' registering it with the page, so that
' it can be targeted by storyboard
' animations
Me.RegisterName("animatedSpecialEffect", animatedSpecialEffect)
' Apply the text effect to the run.
theText.TextEffects = New TextEffectCollection()
theText.TextEffects.Add(animatedSpecialEffect)
' Create a paragraph to contain the run.
Dim animatedParagraph As New Paragraph(theText)
animatedParagraph.Background = Brushes.LightGray
animatedParagraph.Padding = New Thickness(20)
Me.Blocks.Add(animatedParagraph)
Dim controlsContainer As New BlockUIContainer()
'
' Create an animation and a storyboard to animate the
' text effect.
'
Dim countAnimation As New Int32Animation(0, 127, TimeSpan.FromSeconds(10))
Storyboard.SetTargetName(countAnimation, "animatedSpecialEffect")
Storyboard.SetTargetProperty(countAnimation, New PropertyPath(TextEffect.PositionCountProperty))
myStoryboard = New Storyboard()
myStoryboard.Children.Add(countAnimation)
'
' Create some buttons to control the storyboard
' and a panel to contain them.
'
Dim buttonPanel As New StackPanel()
buttonPanel.Orientation = Orientation.Vertical
Dim beginButton As New Button()
beginButton.Content = "Begin"
AddHandler beginButton.Click, AddressOf beginButton_Clicked
buttonPanel.Children.Add(beginButton)
Dim pauseButton As New Button()
pauseButton.Content = "Pause"
AddHandler pauseButton.Click, AddressOf pauseButton_Clicked
buttonPanel.Children.Add(pauseButton)
Dim resumeButton As New Button()
resumeButton.Content = "Resume"
AddHandler resumeButton.Click, AddressOf resumeButton_Clicked
buttonPanel.Children.Add(resumeButton)
Dim skipToFillButton As New Button()
skipToFillButton.Content = "Skip to Fill"
AddHandler skipToFillButton.Click, AddressOf skipToFillButton_Clicked
buttonPanel.Children.Add(skipToFillButton)
Dim setSpeedRatioButton As New Button()
setSpeedRatioButton.Content = "Triple Speed"
AddHandler setSpeedRatioButton.Click, AddressOf setSpeedRatioButton_Clicked
buttonPanel.Children.Add(setSpeedRatioButton)
Dim stopButton As New Button()
stopButton.Content = "Stop"
AddHandler stopButton.Click, AddressOf stopButton_Clicked
buttonPanel.Children.Add(stopButton)
Dim removeButton As New Button()
removeButton.Content = "Remove"
AddHandler removeButton.Click, AddressOf removeButton_Clicked
buttonPanel.Children.Add(removeButton)
controlsContainer.Child = buttonPanel
Me.Blocks.Add(controlsContainer)
End Sub
' Begins the storyboard.
Private Sub beginButton_Clicked(ByVal sender As Object, ByVal args As RoutedEventArgs)
' Specifying "true" as the second Begin parameter
' makes this storyboard controllable.
myStoryboard.Begin(Me, True)
End Sub
' Pauses the storyboard.
Private Sub pauseButton_Clicked(ByVal sender As Object, ByVal args As RoutedEventArgs)
myStoryboard.Pause(Me)
End Sub
' Resumes the storyboard.
Private Sub resumeButton_Clicked(ByVal sender As Object, ByVal args As RoutedEventArgs)
myStoryboard.Resume(Me)
End Sub
' Advances the storyboard to its fill period.
Private Sub skipToFillButton_Clicked(ByVal sender As Object, ByVal args As RoutedEventArgs)
myStoryboard.SkipToFill(Me)
End Sub
' Updates the storyboard's speed.
Private Sub setSpeedRatioButton_Clicked(ByVal sender As Object, ByVal args As RoutedEventArgs)
' Makes the storyboard progress three times as fast as normal.
myStoryboard.SetSpeedRatio(Me, 3)
End Sub
' Stops the storyboard.
Private Sub stopButton_Clicked(ByVal sender As Object, ByVal args As RoutedEventArgs)
myStoryboard.Stop(Me)
End Sub
' Removes the storyboard.
Private Sub removeButton_Clicked(ByVal sender As Object, ByVal args As RoutedEventArgs)
myStoryboard.Remove(Me)
End Sub
End Class
End Namespace
Remarques
Si les propriétés ciblées sont déjà animées, elles sont remplacées à l’aide du comportement de SnapshotAndReplace transfert.
Pour contrôler de manière interactive ce storyboard, vous devez spécifier la même containingObject
chose lors de l’appel des méthodes interactives que vous avez utilisées pour commencer le storyboard
Lorsque cette méthode est appelée, Clock des objets sont créés pour le storyboard et toutes les chronologies qu’elle contient. Ces horloges sont stockées avec containingObject
.
Le démarrage d’une table de montage séquentiel déclenche les CurrentStateInvalidated événements et CurrentGlobalSpeedInvalidated .
S’applique à
Begin(FrameworkElement)
Applique les animations associées à ce Storyboard à leurs cibles et les initialise.
public:
void Begin(System::Windows::FrameworkElement ^ containingObject);
public void Begin (System.Windows.FrameworkElement containingObject);
member this.Begin : System.Windows.FrameworkElement -> unit
Public Sub Begin (containingObject As FrameworkElement)
Paramètres
- containingObject
- FrameworkElement
Objet contenu dans la même portée de nom que les cibles des animations de ce plan conceptuel. Les animations sans TargetName sont appliquées à containingObject
.
Remarques
Si les propriétés ciblées sont déjà animées, elles sont remplacées à l’aide du comportement de SnapshotAndReplace transfert.
Les storyboards démarrés avec cette méthode ne peuvent pas être suspendus, repris ou contrôlés de manière interactive après leur démarrage. Pour rendre une table de montage séquentiel contrôlable, utilisez la Begin(FrameworkElement, Boolean) méthode ou Begin(FrameworkElement, HandoffBehavior, Boolean) .
Le démarrage d’une table de montage séquentiel déclenche les CurrentStateInvalidated événements et CurrentGlobalSpeedInvalidated .
S’applique à
Begin(FrameworkContentElement)
Applique les animations associées à ce Storyboard à leurs cibles et les initialise.
public:
void Begin(System::Windows::FrameworkContentElement ^ containingObject);
public void Begin (System.Windows.FrameworkContentElement containingObject);
member this.Begin : System.Windows.FrameworkContentElement -> unit
Public Sub Begin (containingObject As FrameworkContentElement)
Paramètres
- containingObject
- FrameworkContentElement
Objet contenu dans la même portée de nom que les cibles des animations de ce plan conceptuel. Les animations sans TargetName sont appliquées à containingObject
.
Exemples
L’exemple suivant utilise un storyboard pour animer un TextEffect. le TextEffect est contenu dans l’étendue d’un FrameworkContentElementnom de .
/*
This example shows how to animate
a FrameworkContentElement with a storyboard.
*/
using System;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Media;
using System.Windows.Shapes;
using System.Windows.Media.Animation;
using System.Windows.Documents;
namespace Microsoft.Samples.Animation.AnimatingWithStoryboards
{
public class FrameworkContentElementStoryboardExample : FlowDocument
{
private Storyboard myStoryboard;
public FrameworkContentElementStoryboardExample()
{
// Create a name scope for the document.
NameScope.SetNameScope(this, new NameScope());
this.Background = Brushes.White;
// Create a run of text.
Run theText = new Run(
"Lorem ipsum dolor sit amet, consectetuer adipiscing elit." +
"Ut non lacus. Nullam a ligula id leo adipiscing ornare." +
" Duis mattis. ");
// Create a TextEffect
TextEffect animatedSpecialEffect = new TextEffect();
animatedSpecialEffect.Foreground = Brushes.OrangeRed;
animatedSpecialEffect.PositionStart = 0;
animatedSpecialEffect.PositionCount = 0;
// Assign the TextEffect a name by
// registering it with the page, so that
// it can be targeted by storyboard
// animations
this.RegisterName("animatedSpecialEffect", animatedSpecialEffect);
// Apply the text effect to the run.
theText.TextEffects = new TextEffectCollection();
theText.TextEffects.Add(animatedSpecialEffect);
// Create a paragraph to contain the run.
Paragraph animatedParagraph = new Paragraph(theText);
animatedParagraph.Background = Brushes.LightGray;
animatedParagraph.Padding = new Thickness(20);
this.Blocks.Add(animatedParagraph);
BlockUIContainer controlsContainer = new BlockUIContainer();
//
// Create an animation and a storyboard to animate the
// text effect.
//
Int32Animation countAnimation =
new Int32Animation(0, 127, TimeSpan.FromSeconds(10));
Storyboard.SetTargetName(countAnimation, "animatedSpecialEffect");
Storyboard.SetTargetProperty(countAnimation,
new PropertyPath(TextEffect.PositionCountProperty));
myStoryboard = new Storyboard();
myStoryboard.Children.Add(countAnimation);
//
// Create a button to start the storyboard.
//
Button beginButton = new Button();
beginButton.Content = "Begin";
beginButton.Click += new RoutedEventHandler(beginButton_Clicked);
controlsContainer.Child = beginButton;
this.Blocks.Add(controlsContainer);
}
// Begins the storyboard.
private void beginButton_Clicked(object sender, RoutedEventArgs args)
{
myStoryboard.Begin(this);
}
}
}
'
' This example shows how to animate
' a FrameworkContentElement with a storyboard.
'
'
Imports System.Windows
Imports System.Windows.Controls
Imports System.Windows.Media
Imports System.Windows.Shapes
Imports System.Windows.Media.Animation
Imports System.Windows.Documents
Namespace Microsoft.Samples.Animation.AnimatingWithStoryboards
Public Class FrameworkContentElementStoryboardExample
Inherits FlowDocument
Private myStoryboard As Storyboard
Public Sub New()
' Create a name scope for the document.
NameScope.SetNameScope(Me, New NameScope())
Me.Background = Brushes.White
' Create a run of text.
Dim theText As New Run("Lorem ipsum dolor sit amet, consectetuer adipiscing elit." & "Ut non lacus. Nullam a ligula id leo adipiscing ornare." & " Duis mattis. ")
' Create a TextEffect
Dim animatedSpecialEffect As New TextEffect()
animatedSpecialEffect.Foreground = Brushes.OrangeRed
animatedSpecialEffect.PositionStart = 0
animatedSpecialEffect.PositionCount = 0
' Assign the TextEffect a name by
' registering it with the page, so that
' it can be targeted by storyboard
' animations
Me.RegisterName("animatedSpecialEffect", animatedSpecialEffect)
' Apply the text effect to the run.
theText.TextEffects = New TextEffectCollection()
theText.TextEffects.Add(animatedSpecialEffect)
' Create a paragraph to contain the run.
Dim animatedParagraph As New Paragraph(theText)
animatedParagraph.Background = Brushes.LightGray
animatedParagraph.Padding = New Thickness(20)
Me.Blocks.Add(animatedParagraph)
Dim controlsContainer As New BlockUIContainer()
'
' Create an animation and a storyboard to animate the
' text effect.
'
Dim countAnimation As New Int32Animation(0, 127, TimeSpan.FromSeconds(10))
Storyboard.SetTargetName(countAnimation, "animatedSpecialEffect")
Storyboard.SetTargetProperty(countAnimation, New PropertyPath(TextEffect.PositionCountProperty))
myStoryboard = New Storyboard()
myStoryboard.Children.Add(countAnimation)
'
' Create a button to start the storyboard.
'
Dim beginButton As New Button()
beginButton.Content = "Begin"
AddHandler beginButton.Click, AddressOf beginButton_Clicked
controlsContainer.Child = beginButton
Me.Blocks.Add(controlsContainer)
End Sub
' Begins the storyboard.
Private Sub beginButton_Clicked(ByVal sender As Object, ByVal args As RoutedEventArgs)
myStoryboard.Begin(Me)
End Sub
End Class
End Namespace
Remarques
Si les propriétés ciblées sont déjà animées, elles sont remplacées à l’aide du comportement de SnapshotAndReplace transfert.
Les storyboards démarrés avec cette méthode ne peuvent pas être suspendus, repris ou contrôlés de manière interactive après leur démarrage. Pour rendre une table de montage séquentiel contrôlable, utilisez la Begin méthode ou Begin .
Le démarrage d’une table de montage séquentiel déclenche les CurrentStateInvalidated événements et CurrentGlobalSpeedInvalidated .
S’applique à
Begin()
Applique les animations associées à ce Storyboard à leurs cibles et les initialise.
public:
void Begin();
public void Begin ();
member this.Begin : unit -> unit
Public Sub Begin ()
S’applique à
Begin(FrameworkElement, Boolean)
Applique les animations associées à ce Storyboard à leurs cibles et les initialise.
public:
void Begin(System::Windows::FrameworkElement ^ containingObject, bool isControllable);
public void Begin (System.Windows.FrameworkElement containingObject, bool isControllable);
member this.Begin : System.Windows.FrameworkElement * bool -> unit
Public Sub Begin (containingObject As FrameworkElement, isControllable As Boolean)
Paramètres
- containingObject
- FrameworkElement
Objet contenu dans la même portée de nom que les cibles des animations de ce plan conceptuel. Les animations sans TargetName sont appliquées à containingObject
.
- isControllable
- Boolean
true
si le plan conceptuel doit être contrôlable de façon interactive ; sinon, false
.
Remarques
Si les propriétés ciblées sont déjà animées, elles sont remplacées à l’aide du comportement de SnapshotAndReplace transfert.
Pour contrôler de manière interactive ce storyboard, vous devez utiliser le même containingObject
paramètre lors de l’appel des méthodes interactives que vous avez utilisées pour commencer le storyboard
Lorsque cette méthode est appelée, Clock des objets sont créés pour le storyboard et les chronologies qu’il contient. Ces horloges sont stockées avec containingObject
.
Le démarrage d’un storyboard déclenche les CurrentStateInvalidated événements et CurrentGlobalSpeedInvalidated .
S’applique à
Commentaires
https://aka.ms/ContentUserFeedback.
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultezEnvoyer et afficher des commentaires pour