FrameworkElement.BeginStoryboard 方法

public:
 void BeginStoryboard(System::Windows::Media::Animation::Storyboard ^ storyboard);

public void BeginStoryboard (System.Windows.Media.Animation.Storyboard storyboard);

member this.BeginStoryboard : System.Windows.Media.Animation.Storyboard -> unit

Public Sub BeginStoryboard (storyboard As Storyboard)

参数

示例

下面的示例从资源中检索 Storyboard，然后在对内部事件进行类处理时运行 Storyboard。The following example retrieves a Storyboard from resources, and then runs that Storyboard when an internal event is class handled.

private void OnImage1Animate(object sender, RoutedEventArgs e)
{
    Storyboard s;

    s = (Storyboard)this.FindResource("RotateStoryboard");
    this.BeginStoryboard(s);
}

Private Sub OnImage1Animate(ByVal sender As Object, ByVal e As RoutedEventArgs)
    Dim s As Storyboard

    s = CType(Me.FindResource("RotateStoryboard"), Storyboard)
    Me.BeginStoryboard(s)
End Sub

注解

最典型的动画方案不使用此方法。Most typical animation scenarios do not use this method. 通常，您将在标记中创建 Storyboard 或 BeginStoryboard 元素，然后将它们放置为元素上的 EventTrigger 内容。Typically, you create the Storyboard or BeginStoryboard element in markup, and then you place these as the EventTrigger content on an element. 当事件触发时，动画将运行。When triggered by the event, the animation then runs. Storyboard 的大部分控制方面都可以通过在标记中公开的属性进行寻址。Most of the control aspects of a Storyboard can be addressed by properties that are exposed in markup.

对于不使用 isControllable、参数或指定该参数的签名 false，一旦动画达到 "填充" 时间段，就会删除与动画关联的时间线时钟。For the signatures that do not use the isControllable, parameter, or when that parameter is specified false, the timeline clocks that are associated with the animation are removed as soon as the animation reaches the "Fill" period. 因此，不能在运行后重新启动动画。Therefore the animation cannot be restarted after running once. 控制动画还要求情节提要具有X：Name 指令或可通过代码中的引用进行访问。Controlling an animation also requires that the storyboard have an x:Name Directive or be accessible by reference in code.

public:
 void BeginStoryboard(System::Windows::Media::Animation::Storyboard ^ storyboard, System::Windows::Media::Animation::HandoffBehavior handoffBehavior);

public void BeginStoryboard (System.Windows.Media.Animation.Storyboard storyboard, System.Windows.Media.Animation.HandoffBehavior handoffBehavior);

member this.BeginStoryboard : System.Windows.Media.Animation.Storyboard * System.Windows.Media.Animation.HandoffBehavior -> unit

Public Sub BeginStoryboard (storyboard As Storyboard, handoffBehavior As HandoffBehavior)

参数

示例

下面的示例从资源中检索 Storyboard，然后在对内部事件进行类处理时运行 Storyboard。The following example retrieves a Storyboard from resources, and then runs that Storyboard when an internal event is class handled.

private void OnImage1Animate(object sender, RoutedEventArgs e)
{
    Storyboard s;

    s = (Storyboard)this.FindResource("RotateStoryboard");
    this.BeginStoryboard(s);
}

Private Sub OnImage1Animate(ByVal sender As Object, ByVal e As RoutedEventArgs)
    Dim s As Storyboard

    s = CType(Me.FindResource("RotateStoryboard"), Storyboard)
    Me.BeginStoryboard(s)
End Sub

注解

最典型的动画方案不使用此方法。Most typical animation scenarios do not use this method. 通常，您将在标记中创建 Storyboard 或 BeginStoryboard 元素，然后将它们放置为元素上的 EventTrigger 内容。Typically, you create the Storyboard or BeginStoryboard element in markup, and then you place these as the EventTrigger content on an element. 当事件触发时，动画将运行。When triggered by the event, the animation then runs. Storyboard 的大部分控制方面都可以通过在标记中公开的属性进行寻址。Most of the control aspects of a Storyboard can be addressed by properties that are exposed in markup.

对于不使用 isControllable、参数或指定该参数的签名 false，一旦动画达到 "填充" 时间段，就会删除与动画关联的时间线时钟。For the signatures that do not use the isControllable, parameter, or when that parameter is specified false, the timeline clocks that are associated with the animation are removed as soon as the animation reaches the "Fill" period. 因此，不能在运行后重新启动动画。Therefore the animation cannot be restarted after running once. 控制动画还要求情节提要具有X：Name 指令或可通过代码中的引用进行访问。Controlling an animation also requires that the storyboard have an x:Name Directive or be accessible by reference in code.

可以将移交行为指定为 BeginStoryboard的属性。Handoff behavior can be specified as an attribute of BeginStoryboard.

使用撰写 HandoffBehaviorUsing the Compose HandoffBehavior

使用 Compose HandoffBehavior将 Storyboard、AnimationTimeline或 AnimationClock 应用于属性时，以前与该属性关联的任何 Clock 对象将继续使用系统资源;计时系统不会自动删除时钟。When you apply a Storyboard, AnimationTimeline, or AnimationClock to a property by using the Compose HandoffBehavior, any Clock objects previously associated with that property continue to consume system resources; the timing system does not remove the clocks automatically.

为了避免在使用 Compose应用大量时钟时出现性能问题，应在完成后从动画属性中删除组合时钟。To avoid performance issues when you apply a large number of clocks by using Compose, you should remove composing clocks from the animated property after they complete. 有几种方法可以删除时钟：There are several ways to remove a clock:

• 若要从属性中删除所有时钟，请使用动画对象的 ApplyAnimationClock(DependencyProperty, AnimationClock) 或 BeginAnimation(DependencyProperty, AnimationTimeline) 方法。To remove all clocks from a property, use the ApplyAnimationClock(DependencyProperty, AnimationClock) or BeginAnimation(DependencyProperty, AnimationTimeline) method of the animated object. 指定正在进行动画处理的属性作为第一个参数，并 null 为第二个参数。Specify the property being animated as the first parameter, and null as the second. 这将从属性中移除所有动画时钟。This removes all animation clocks from the property.

• 若要从时钟列表中删除特定 AnimationClock，请使用 AnimationClock 的 Controller 属性检索 ClockController，然后调用 Remove 的 ClockController方法。To remove a specific AnimationClock from a list of clocks, use the Controller property of the AnimationClock to retrieve a ClockController, then call the Remove method of the ClockController. 通常在时钟的 Completed 事件处理程序中完成此操作。This is typically done in the Completed event handler for a clock. 请注意，只能通过 ClockController来控制根时钟;子时钟的 Controller 属性返回 null。Note that only root clocks can be controlled by a ClockController; the Controller property of a child clock returns null. 另请注意，如果时钟的有效持续时间是永久性的，则不会引发 Completed 事件。Note also that the Completed event is not raised if the effective duration of the clock is forever. 在这种情况下，用户必须确定何时调用 Remove。In that case, the user must determine when to call Remove.

此动画问题主要出现在生存期较长的对象上。This is primarily an issue for animations on objects that have a long lifetime. 当对对象进行垃圾回收时，还会断开其时钟的连接并对其进行垃圾回收。When an object is garbage collected, its clocks are also disconnected and garbage collected.

有关时钟对象的详细信息，请参阅动画和计时系统概述。For more information about clock objects, see Animation and Timing System Overview.

public:
 void BeginStoryboard(System::Windows::Media::Animation::Storyboard ^ storyboard, System::Windows::Media::Animation::HandoffBehavior handoffBehavior, bool isControllable);

public void BeginStoryboard (System.Windows.Media.Animation.Storyboard storyboard, System.Windows.Media.Animation.HandoffBehavior handoffBehavior, bool isControllable);

member this.BeginStoryboard : System.Windows.Media.Animation.Storyboard * System.Windows.Media.Animation.HandoffBehavior * bool -> unit

Public Sub BeginStoryboard (storyboard As Storyboard, handoffBehavior As HandoffBehavior, isControllable As Boolean)

参数

注解

最典型的动画方案不使用此方法。Most typical animation scenarios do not use this method. 通常，您将在标记中创建 Storyboard 或 BeginStoryboard 元素，然后将它们放置为元素上的 EventTrigger 内容。Typically, you create the Storyboard or BeginStoryboard element in markup, and then you place these as the EventTrigger content on an element. 当事件触发时，动画将运行。When triggered by the event, the animation then runs. Storyboard 的大部分控制方面都可以通过在标记中公开的属性进行寻址。Most of the control aspects of a Storyboard can be addressed by properties that are exposed in markup.

对于不使用 isControllable、参数或指定该参数的签名 false，一旦动画达到 "填充" 时间段，就会删除与动画关联的时间线时钟。For the signatures that do not use the isControllable, parameter, or when that parameter is specified false, the timeline clocks that are associated with the animation are removed as soon as the animation reaches the "Fill" period. 因此，不能在运行后重新启动动画。Therefore the animation cannot be restarted after running once. 控制动画还要求情节提要具有X：Name 指令或可通过代码中的引用进行访问。Controlling an animation also requires that the storyboard have an x:Name Directive or be accessible by reference in code.

可以将移交行为指定为 BeginStoryboard的属性。Handoff behavior can be specified as an attribute of BeginStoryboard.

使用撰写 HandoffBehaviorUsing the Compose HandoffBehavior

使用 Compose HandoffBehavior将 Storyboard、AnimationTimeline或 AnimationClock 应用于属性时，以前与该属性关联的任何 Clock 对象将继续使用系统资源;计时系统不会自动删除时钟。When you apply a Storyboard, AnimationTimeline, or AnimationClock to a property by using the Compose HandoffBehavior, any Clock objects previously associated with that property continue to consume system resources; the timing system does not remove the clocks automatically.

为了避免在使用 Compose应用大量时钟时出现性能问题，应在完成后从动画属性中删除组合时钟。To avoid performance issues when you apply a large number of clocks by using Compose, you should remove composing clocks from the animated property after they complete. 有几种方法可以删除时钟：There are several ways to remove a clock:

• 若要从属性中删除所有时钟，请使用动画对象的 ApplyAnimationClock(DependencyProperty, AnimationClock) 或 BeginAnimation(DependencyProperty, AnimationTimeline) 方法。To remove all clocks from a property, use the ApplyAnimationClock(DependencyProperty, AnimationClock) or BeginAnimation(DependencyProperty, AnimationTimeline) method of the animated object. 指定正在进行动画处理的属性作为第一个参数，并 null 为第二个参数。Specify the property being animated as the first parameter, and null as the second. 这将从属性中移除所有动画时钟。This removes all animation clocks from the property.

• 若要从时钟列表中删除特定 AnimationClock，请使用 AnimationClock 的 Controller 属性检索 ClockController，然后调用 Remove 的 ClockController方法。To remove a specific AnimationClock from a list of clocks, use the Controller property of the AnimationClock to retrieve a ClockController, then call the Remove method of the ClockController. 通常在时钟的 Completed 事件处理程序中完成此操作。This is typically done in the Completed event handler for a clock. 请注意，只能通过 ClockController来控制根时钟;子时钟的 Controller 属性返回 null。Note that only root clocks can be controlled by a ClockController; the Controller property of a child clock returns null. 另请注意，如果时钟的有效持续时间是永久性的，则不会引发 Completed 事件。Note also that the Completed event is not raised if the effective duration of the clock is forever. 在这种情况下，用户必须确定何时调用 Remove。In that case, the user must determine when to call Remove.

此动画问题主要出现在生存期较长的对象上。This is primarily an issue for animations on objects that have a long lifetime. 当对对象进行垃圾回收时，还会断开其时钟的连接并对其进行垃圾回收。When an object is garbage collected, its clocks are also disconnected and garbage collected.

有关时钟对象的详细信息，请参阅动画和计时系统概述。For more information about clock objects, see Animation and Timing System Overview.