Storyboard.Pause 方法

  • 參考

定義

命名空間:
System.Windows.Media.Animation
組件:
PresentationFramework.dll

暫停與這個 Clock 所建立的 Storyboard。

多載

Pause()

暫停與這個 Clock 所建立的 Storyboard。
Pause(FrameworkContentElement)

暫停與這個 Storyboard 相關聯之指定 FrameworkContentElement 的 Clock。
Pause(FrameworkElement)

暫停與這個 Storyboard 相關聯之指定 FrameworkElement 的 Clock。

Pause()

暫停與這個 Clock 所建立的 Storyboard。

public:
 void Pause();
public void Pause ();
member this.Pause : unit -> unit
Public Sub Pause ()

備註

這個方法會暫停分鏡腳本，但如果腳本不是使用中或目前暫停，則不會有明顯的效果。 副作用是，所有相關聯的子系也會暫停。

可控制的分鏡腳本可以暫停、繼續、搜尋、停止和移除。 若要在程式碼中控制分鏡 Begin 腳本，您必須使用腳本方法的適當多載，並指定 true 以使其可控制。 如需範例，請參閱 如何：在腳本啟動之後控制分鏡腳本。

開始暫停的分鏡腳本

當您 Begin 暫停的分鏡腳本時，它似乎會繼續並重新啟動。 不過，這不是實際發生的情況。 方法 Begin 實際上會將暫停 Storyboard 的 取代為新的未暫停版本。 每次呼叫 方法時 Begin ，都會為分鏡腳本建立時鐘物件。 這些時鐘會散發到其動畫的屬性。 因此，當再次呼叫 方法時 Begin ，它不會重新開機其時鐘;它會以新的時鐘取代它們。

適用於

Pause(FrameworkContentElement)

暫停與這個 Storyboard 相關聯之指定 FrameworkContentElement 的 Clock。

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)

參數

containingObject
FrameworkContentElement

呼叫 Begin(FrameworkContentElement, Boolean) 方法時指定的物件。 此物件包含為這個腳本和其子系所建立的 Clock 物件。

範例

下列範例使用可控制的分鏡腳本來建立 TextEffect 動畫。 TextEffect包含在 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

備註

這個方法會暫停分鏡腳本，但如果腳本不是使用中或目前暫停，則不會有明顯的效果。 副作用是，所有相關聯的子系也會暫停。

搜尋暫停的分鏡腳本不會繼續。 繼續暫停分鏡腳本的唯一方法是使用 Resume 方法。 Begin再次呼叫 方法會將暫停的分鏡腳本取代為新的腳本，其外觀為繼續腳本。

若要以互動方式控制此分鏡腳本，您必須在呼叫您用來開始分鏡腳本的互動式方法時使用相同的 containingObject 參數。 可控制的分鏡腳本可以暫停、繼續、搜尋、停止和移除。 若要在程式碼中控制分鏡 Begin 腳本，您必須使用腳本方法的適當多載，並指定 true 以使其可控制。 例如，請參閱 如何：在腳本啟動之後控制分鏡腳本。

暫停分鏡腳本的時鐘會 CurrentGlobalSpeedInvalidated 觸發事件。

開始暫停的分鏡腳本

當您 Begin 暫停的分鏡腳本時，它似乎會繼續並重新啟動。 不過，這不是實際發生的情況。 方法 Begin 實際上會以未暫停的版本取代本身。 每次呼叫 方法時 Begin ，都會為分鏡腳本建立時鐘物件。 這些時鐘會散發到其動畫的屬性。 因此，當再次呼叫 方法時 Begin ，它不會重新開機其時鐘;它會以新的時鐘取代它們。

另請參閱

適用於

Pause(FrameworkElement)

暫停與這個 Storyboard 相關聯之指定 FrameworkElement 的 Clock。

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)

參數

containingObject
FrameworkElement

呼叫 Begin(FrameworkElement, Boolean) 方法時指定的物件。 此物件包含為這個腳本和其子系所建立的 Clock 物件。

備註

這個方法會暫停分鏡腳本，但如果腳本不是使用中或目前暫停，則不會有明顯的效果。 副作用是，所有相關聯的子系也會暫停。

搜尋暫停的分鏡腳本不會繼續。 繼續暫停分鏡腳本的唯一方法是使用 Resume 方法。 Begin再次呼叫 方法會將暫停的分鏡腳本取代為新的腳本，其外觀為繼續腳本。

若要以互動方式控制此分鏡腳本，您必須在呼叫您用來開始分鏡腳本的互動式方法時使用相同的 containingObject 參數。 可控制的分鏡腳本可以暫停、繼續、搜尋、停止和移除。 若要在程式碼中控制分鏡 Begin 腳本，您必須使用腳本方法的適當多載，並指定 true 以使其可控制。 如需範例，請參閱 如何：在腳本啟動之後控制分鏡腳本。

暫停分鏡腳本的時鐘會 CurrentGlobalSpeedInvalidated 觸發事件。

開始暫停的分鏡腳本

當您 Begin 暫停的分鏡腳本時，它似乎會繼續並重新啟動。 不過，這不是實際發生的情況。 方法 Begin 實際上會以未暫停的版本取代本身。 每次呼叫 方法時 Begin ，都會為分鏡腳本建立時鐘物件。 這些時鐘會散發到其動畫的屬性。 因此，當再次呼叫 方法時 Begin ，它不會重新開機其時鐘;它會以新的時鐘取代它們。

另請參閱

適用於