Storyboard.Pause メソッド

リファレンス

定義

名前空間:: System.Windows.Media.Animation

アセンブリ:: PresentationFramework.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

この 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 再度呼び出されると、そのクロックは再起動されません。新しいクロックに置き換えられます。

こちらもご覧ください

Resume(FrameworkContentElement)

適用対象

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 オブジェクトが格納されます。

注釈

ストーリーボードのクロックを一時停止すると、イベントが CurrentGlobalSpeedInvalidated トリガーされます。

一時停止したストーリーボードの開始

こちらもご覧ください

Resume(FrameworkElement)

適用対象

次の方法で共有

Storyboard.Pause メソッド

定義

オーバーロード

Pause()

注釈

一時停止したストーリーボードの開始

適用対象

Pause(FrameworkContentElement)

パラメーター

例

注釈

一時停止したストーリーボードの開始

こちらもご覧ください

適用対象

Pause(FrameworkElement)

パラメーター

注釈

一時停止したストーリーボードの開始

こちらもご覧ください

適用対象

その他のリソース