Storyboard.Pause Methode
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Hält die Clock , die für dieses Storyboardzugeordnet ist.
Überlädt
Pause() |
Hält die Clock , die für dieses Storyboardzugeordnet ist. |
Pause(FrameworkContentElement) |
Hält die Clock des angegebenen FrameworkContentElement an, das diesem Storyboard zugeordnet ist. |
Pause(FrameworkElement) |
Hält die Clock des angegebenen FrameworkElement an, das diesem Storyboard zugeordnet ist. |
Pause()
Hält die Clock , die für dieses Storyboardzugeordnet ist.
public:
void Pause();
public void Pause ();
member this.Pause : unit -> unit
Public Sub Pause ()
Hinweise
Diese Methode hält das Storyboard an, hat aber keine erkennbare Auswirkung, wenn es nicht aktiv oder derzeit angehalten ist. Als Nebeneffekt werden auch alle zugeordneten untergeordneten Elemente angehalten.
Ein steuerbares Storyboard kann anhalten, fortsetzen, suchen, beenden und entfernt werden. Um ein Storyboard im Code steuerbar zu machen, müssen Sie die entsprechende Überladung der Storyboardmethode Begin verwenden und angeben true
, um sie steuerbar zu machen. Ein Beispiel finden Sie unter Vorgehensweise: Steuern eines Storyboards nach dem Start.
Starten eines angehaltenen Storyboards
Wenn Sie Begin ein Storyboard angehalten haben, scheint es fortzusetzen und neu zu starten. Das ist jedoch nicht das, was tatsächlich geschieht. Die Begin -Methode ersetzt tatsächlich die angehaltene Storyboard durch eine neue nicht angehaltene Version. Jedes Mal, wenn die Begin Methode aufgerufen wird, werden Uhrobjekte für das Storyboard erstellt. Diese Uhren werden auf die Eigenschaften verteilt, die sie animieren. Wenn die Begin Methode also erneut aufgerufen wird, startet sie ihre Uhren nicht neu, sie ersetzt sie durch neue Uhren.
Gilt für:
Pause(FrameworkContentElement)
Hält die Clock des angegebenen FrameworkContentElement an, das diesem Storyboard zugeordnet ist.
public:
void Pause(System::Windows::FrameworkContentElement ^ containingObject);
public void Pause (System.Windows.FrameworkContentElement containingObject);
member this.Pause : System.Windows.FrameworkContentElement -> unit
Public Sub Pause (containingObject As FrameworkContentElement)
Parameter
- containingObject
- FrameworkContentElement
Das beim Aufrufen der Begin(FrameworkContentElement, Boolean)-Methode angegebene Objekt. Dieses Objekt enthält die Clock-Objekte, die für dieses Storyboard und seine untergeordneten Elemente erstellt wurden.
Beispiele
Im folgenden Beispiel wird ein steuerbares Storyboard zum Animieren eines TextEffectverwendet. ist TextEffect innerhalb des Namensbereichs enthalten FrameworkContentElement.
/*
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
Hinweise
Diese Methode hält das Storyboard an, hat aber keine erkennbare Auswirkung, wenn es nicht aktiv oder derzeit angehalten ist. Als Nebeneffekt werden auch alle zugeordneten untergeordneten Elemente angehalten.
Die Suche nach einem angehaltenen Storyboard wird nicht fortgesetzt. Die einzige Möglichkeit, ein angehaltenes Storyboard fortzusetzen, besteht darin, die Resume -Methode zu verwenden. Durch erneutes Aufrufen der Begin -Methode wird das angehaltene Storyboard durch ein neues ersetzt, das den Anschein hat, dass es fortgesetzt wird.
Um dieses Storyboard interaktiv zu steuern, müssen Sie denselben containingObject
Parameter verwenden, wenn Sie die interaktiven Methoden aufrufen, die Sie zum Starten des Storyboards verwendet haben. Ein steuerbares Storyboard kann anhalten, fortsetzen, suchen, beenden und entfernt werden. Um ein Storyboard im Code steuerbar zu machen, müssen Sie die entsprechende Überladung der Storyboardmethode Begin verwenden und angeben true
, um sie steuerbar zu machen. Ein Beispiel finden Sie unter Vorgehensweise: Steuern eines Storyboards nach dem Start.
Das Anhalten der Uhr eines Storyboards löst das CurrentGlobalSpeedInvalidated Ereignis aus.
Starten eines angehaltenen Storyboards
Wenn Sie Begin ein Storyboard angehalten haben, scheint es fortzusetzen und neu zu starten. Das ist jedoch nicht das, was tatsächlich geschieht. Die Begin -Methode ersetzt sich selbst durch eine nicht angehaltene Version. Jedes Mal, wenn die Begin Methode aufgerufen wird, werden Uhrobjekte für das Storyboard erstellt. Diese Uhren werden auf die Eigenschaften verteilt, die sie animieren. Wenn die Begin Methode also erneut aufgerufen wird, startet sie ihre Uhren nicht neu, sie ersetzt sie durch neue Uhren.
Weitere Informationen
Gilt für:
Pause(FrameworkElement)
Hält die Clock des angegebenen FrameworkElement an, das diesem Storyboard zugeordnet ist.
public:
void Pause(System::Windows::FrameworkElement ^ containingObject);
public void Pause (System.Windows.FrameworkElement containingObject);
member this.Pause : System.Windows.FrameworkElement -> unit
Public Sub Pause (containingObject As FrameworkElement)
Parameter
- containingObject
- FrameworkElement
Das beim Aufrufen der Begin(FrameworkElement, Boolean)-Methode angegebene Objekt. Dieses Objekt enthält die Clock-Objekte, die für dieses Storyboard und seine untergeordneten Elemente erstellt wurden.
Hinweise
Diese Methode hält das Storyboard an, hat aber keine erkennbare Auswirkung, wenn es nicht aktiv oder derzeit angehalten ist. Als Nebeneffekt werden auch alle zugeordneten untergeordneten Elemente angehalten.
Die Suche nach einem angehaltenen Storyboard wird nicht fortgesetzt. Die einzige Möglichkeit, ein angehaltenes Storyboard fortzusetzen, besteht darin, die Resume -Methode zu verwenden. Durch erneutes Aufrufen der Begin -Methode wird das angehaltene Storyboard durch ein neues ersetzt, das den Anschein hat, dass es fortgesetzt wird.
Um dieses Storyboard interaktiv zu steuern, müssen Sie denselben containingObject
Parameter verwenden, wenn Sie die interaktiven Methoden aufrufen, die Sie zum Starten des Storyboards verwendet haben. Ein steuerbares Storyboard kann anhalten, fortsetzen, suchen, beenden und entfernt werden. Um ein Storyboard im Code steuerbar zu machen, müssen Sie die entsprechende Überladung der Storyboardmethode Begin verwenden und angeben true
, um sie steuerbar zu machen. Ein Beispiel finden Sie unter Vorgehensweise: Steuern eines Storyboards nach dem Start.
Das Anhalten der Uhr eines Storyboards löst das CurrentGlobalSpeedInvalidated Ereignis aus.
Starten eines angehaltenen Storyboards
Wenn Sie Begin ein Storyboard angehalten haben, scheint es fortzusetzen und neu zu starten. Das ist jedoch nicht das, was tatsächlich geschieht. Die Begin -Methode ersetzt sich selbst durch eine nicht angehaltene Version. Jedes Mal, wenn die Begin Methode aufgerufen wird, werden Uhrobjekte für das Storyboard erstellt. Diese Uhren werden auf die Eigenschaften verteilt, die sie animieren. Wenn die Begin Methode also erneut aufgerufen wird, startet sie ihre Uhren nicht neu, sie ersetzt sie durch neue Uhren.