Storyboard.SetSpeedRatio Método

Definición

Establece la relación de velocidad interactiva del objeto Clock que se creó para este objeto Storyboard.

Sobrecargas

SetSpeedRatio(Double)

Establece la relación de velocidad interactiva del objeto Clock que se creó para este objeto Storyboard.

SetSpeedRatio(FrameworkContentElement, Double)

Establece la relación de velocidad interactiva del Clock que se creó para este Storyboard.

SetSpeedRatio(FrameworkElement, Double)

Establece la relación de velocidad interactiva del Clock que se creó para este Storyboard.

SetSpeedRatio(Double)

Establece la relación de velocidad interactiva del objeto Clock que se creó para este objeto Storyboard.

public void SetSpeedRatio (double speedRatio);

Parámetros

speedRatio
Double

Valor finito mayor que cero que es la nueva relación de velocidad interactiva del guión gráfico. Este valor se multiplica por el valor SpeedRatio del guión gráfico para determinar la velocidad efectiva del guión gráfico. Este valor no sobrescribe la propiedad SpeedRatio del guión gráfico. Por ejemplo, llamar a este método y especificar una relación de velocidad interactiva de 3 en un guión gráfico con una SpeedRatio de 0.5 asigna al guión gráfico una velocidad efectiva de 1.5.

Comentarios

Un guión gráfico controlable puede pausar, reanudar, buscar, detener y quitarse. Para que un guión gráfico sea controlable en el código, debe usar la sobrecarga adecuada del método del Begin guión gráfico y especificar true para que sea controlable. Para obtener un ejemplo, vea Cómo: Controlar un guión gráfico después de que se inicie.

Se aplica a

.NET Framework 4.8.1 otras versiones
Producto Versiones
.NET Framework 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop 3.0, 3.1, 5, 6, 7, 8, 9

SetSpeedRatio(FrameworkContentElement, Double)

Establece la relación de velocidad interactiva del Clock que se creó para este Storyboard.

public void SetSpeedRatio (System.Windows.FrameworkContentElement containingObject, double speedRatio);

Parámetros

containingObject
FrameworkContentElement

Objeto especificado cuando se llamó al método Begin(FrameworkContentElement, Boolean). Este objeto contiene los objetos Clock que se crearon para este guion gráfico y sus elementos secundarios.

speedRatio
Double

Valor finito mayor que cero que es la nueva relación de velocidad interactiva del guión gráfico. Este valor se multiplica por el valor SpeedRatio del guión gráfico para determinar la velocidad efectiva del guión gráfico. Este valor no sobrescribe la propiedad SpeedRatio del guión gráfico. Por ejemplo, llamar a este método y especificar una relación de velocidad interactiva de 3 en un guión gráfico con una SpeedRatio de 0.5 asigna al guión gráfico una velocidad efectiva de 1.5.

Ejemplos

En el ejemplo siguiente se usa un guión gráfico controlable para animar un TextEffectobjeto . TextEffect está incluido en el ámbito de nombre de un 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);          
        }           
    }
}

Comentarios

Para controlar interactivamente este guión gráfico, debe usar el mismo containingObject parámetro al llamar a los métodos interactivos que usó para comenzar el guión gráfico. Un guión gráfico controlable puede pausar, reanudar, buscar, detener y quitarse. Para que un guión gráfico sea controlable en el código, debe usar la sobrecarga adecuada del método del Begin guión gráfico y especificar true para que sea controlable. Para obtener un ejemplo, vea Cómo: Controlar un guión gráfico después de que se inicie.

Al llamar a este método, se desencadena el CurrentGlobalSpeedInvalidated evento .

Se aplica a

.NET Framework 4.8.1 otras versiones
Producto Versiones
.NET Framework 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop 3.0, 3.1, 5, 6, 7, 8, 9

SetSpeedRatio(FrameworkElement, Double)

Establece la relación de velocidad interactiva del Clock que se creó para este Storyboard.

public void SetSpeedRatio (System.Windows.FrameworkElement containingObject, double speedRatio);

Parámetros

containingObject
FrameworkElement

Objeto especificado cuando se llamó al método Begin(FrameworkElement, Boolean). Este objeto contiene los objetos Clock que se crearon para este guion gráfico y sus elementos secundarios.

speedRatio
Double

Valor finito mayor que cero que es la nueva relación de velocidad interactiva del guión gráfico. Este valor se multiplica por el valor SpeedRatio del guión gráfico para determinar la velocidad efectiva del guión gráfico. Este valor no sobrescribe la propiedad SpeedRatio del guión gráfico. Por ejemplo, llamar a este método y especificar una relación de velocidad interactiva de 3 en un guión gráfico con una SpeedRatio de 0.5 asigna al guión gráfico una velocidad efectiva de 1.5.

Comentarios

Para controlar interactivamente este guión gráfico, debe usar el mismo containingObject parámetro al llamar a los métodos interactivos que usó para comenzar el guión gráfico. Un guión gráfico controlable puede pausar, reanudar, buscar, detener y quitarse. Para que un guión gráfico sea controlable en el código, debe usar la sobrecarga adecuada del método del Begin guión gráfico y especificar true para que sea controlable. Para obtener un ejemplo, vea Cómo: Controlar un guión gráfico después de que se inicie.

Al llamar a este método, se desencadena el CurrentGlobalSpeedInvalidated evento .

Se aplica a

.NET Framework 4.8.1 otras versiones
Producto Versiones
.NET Framework 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop 3.0, 3.1, 5, 6, 7, 8, 9