Partilhar via


Storyboard.SetSpeedRatio Método

Definição

Define a taxa de velocidade interativa para o Clock que foi criado para este Storyboard.

Sobrecargas

SetSpeedRatio(Double)

Define a taxa de velocidade interativa para o Clock que foi criado para este Storyboard.

SetSpeedRatio(FrameworkContentElement, Double)

Define a taxa de velocidade interativa do Clock que foi criado para este Storyboard.

SetSpeedRatio(FrameworkElement, Double)

Define a taxa de velocidade interativa do Clock que foi criado para este Storyboard.

SetSpeedRatio(Double)

Define a taxa de velocidade interativa para o Clock que foi criado para este Storyboard.

public:
 void SetSpeedRatio(double speedRatio);
public void SetSpeedRatio (double speedRatio);
member this.SetSpeedRatio : double -> unit
Public Sub SetSpeedRatio (speedRatio As Double)

Parâmetros

speedRatio
Double

Um valor finito maior que zero é a nova razão de velocidade interativa do storyboard. Esse valor é multiplicado pelo valor SpeedRatio do storyboard para determinar a velocidade efetiva do storyboard. Esse valor não substituirá a propriedade SpeedRatio do storyboard. Por exemplo, chamar este método e especificar uma razão de velocidade interativa de 3 em um storyboard com um SpeedRatio de 0,5 proporciona ao storyboard uma velocidade efetiva de 1,5.

Comentários

Um storyboard controlável pode pausar, retomar, procurar, parar e ser removido. Para tornar um storyboard controlável em código, você deve usar a sobrecarga apropriada do método do Begin storyboard e especificar true para torná-lo controlável. Para obter um exemplo, consulte Como controlar um storyboard após o início.

Aplica-se a

SetSpeedRatio(FrameworkContentElement, Double)

Define a taxa de velocidade interativa do Clock que foi criado para este Storyboard.

public:
 void SetSpeedRatio(System::Windows::FrameworkContentElement ^ containingObject, double speedRatio);
public void SetSpeedRatio (System.Windows.FrameworkContentElement containingObject, double speedRatio);
member this.SetSpeedRatio : System.Windows.FrameworkContentElement * double -> unit
Public Sub SetSpeedRatio (containingObject As FrameworkContentElement, speedRatio As Double)

Parâmetros

containingObject
FrameworkContentElement

O objeto especificado quando o método Begin(FrameworkContentElement, Boolean) foi chamado. Esse objeto contém os objetos Clock que foram criados para esse storyboard e seus filhos.

speedRatio
Double

Um valor finito maior que zero é a nova razão de velocidade interativa do storyboard. Esse valor é multiplicado pelo valor SpeedRatio do storyboard para determinar a velocidade efetiva do storyboard. Esse valor não substituirá a propriedade SpeedRatio do storyboard. Por exemplo, chamar este método e especificar uma razão de velocidade interativa de 3 em um storyboard com um SpeedRatio de 0,5 proporciona ao storyboard uma velocidade efetiva de 1,5.

Exemplos

O exemplo a seguir usa um storyboard controlável para animar um TextEffect. O TextEffect está contido no escopo do nome de um 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

Comentários

Para controlar interativamente esse storyboard, você deve usar o mesmo containingObject parâmetro ao chamar os métodos interativos usados para iniciar o storyboard. Um storyboard controlável pode pausar, retomar, procurar, parar e ser removido. Para tornar um storyboard controlável em código, você deve usar a sobrecarga apropriada do método do Begin storyboard e especificar true para torná-lo controlável. Para obter um exemplo, consulte Como controlar um storyboard após o início.

Chamar esse método dispara o CurrentGlobalSpeedInvalidated evento.

Aplica-se a

SetSpeedRatio(FrameworkElement, Double)

Define a taxa de velocidade interativa do Clock que foi criado para este Storyboard.

public:
 void SetSpeedRatio(System::Windows::FrameworkElement ^ containingObject, double speedRatio);
public void SetSpeedRatio (System.Windows.FrameworkElement containingObject, double speedRatio);
member this.SetSpeedRatio : System.Windows.FrameworkElement * double -> unit
Public Sub SetSpeedRatio (containingObject As FrameworkElement, speedRatio As Double)

Parâmetros

containingObject
FrameworkElement

O objeto especificado quando o método Begin(FrameworkElement, Boolean) foi chamado. Esse objeto contém os objetos Clock que foram criados para esse storyboard e seus filhos.

speedRatio
Double

Um valor finito maior que zero é a nova razão de velocidade interativa do storyboard. Esse valor é multiplicado pelo valor SpeedRatio do storyboard para determinar a velocidade efetiva do storyboard. Esse valor não substituirá a propriedade SpeedRatio do storyboard. Por exemplo, chamar este método e especificar uma razão de velocidade interativa de 3 em um storyboard com um SpeedRatio de 0,5 proporciona ao storyboard uma velocidade efetiva de 1,5.

Comentários

Para controlar interativamente esse storyboard, você deve usar o mesmo containingObject parâmetro ao chamar os métodos interativos usados para iniciar o storyboard. Um storyboard controlável pode pausar, retomar, procurar, parar e ser removido. Para tornar um storyboard controlável em código, você deve usar a sobrecarga apropriada do método do Begin storyboard e especificar true para torná-lo controlável. Para obter um exemplo, consulte Como controlar um storyboard após o início.

Chamar esse método dispara o CurrentGlobalSpeedInvalidated evento.

Aplica-se a