-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
StopStoryboard.xml
78 lines (73 loc) · 6.26 KB
/
StopStoryboard.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
<Type Name="StopStoryboard" FullName="System.Windows.Media.Animation.StopStoryboard">
<TypeSignature Language="C#" Value="public sealed class StopStoryboard : System.Windows.Media.Animation.ControllableStoryboardAction" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit StopStoryboard extends System.Windows.Media.Animation.ControllableStoryboardAction" />
<TypeSignature Language="DocId" Value="T:System.Windows.Media.Animation.StopStoryboard" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class StopStoryboard
Inherits ControllableStoryboardAction" />
<TypeSignature Language="F#" Value="type StopStoryboard = class
 inherit ControllableStoryboardAction" />
<TypeSignature Language="C++ CLI" Value="public ref class StopStoryboard sealed : System::Windows::Media::Animation::ControllableStoryboardAction" />
<AssemblyInfo>
<AssemblyName>PresentationFramework</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Windows.Media.Animation.ControllableStoryboardAction</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>A trigger action that stops a <see cref="T:System.Windows.Media.Animation.Storyboard" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use a <xref:System.Windows.Media.Animation.StopStoryboard> action with an <xref:System.Windows.EventTrigger> or <xref:System.Windows.Trigger> to interactively stop a <xref:System.Windows.Media.Animation.Storyboard>.
<xref:System.Windows.Media.Animation.StopStoryboard> only affects a <xref:System.Windows.Media.Animation.Storyboard> when it is active (after the <xref:System.Windows.Media.Animation.Storyboard> starts). Stopping a storyboard triggers the <xref:System.Windows.Media.Animation.Timeline.CurrentGlobalSpeedInvalidated> and <xref:System.Windows.Media.Animation.Timeline.CurrentStateInvalidated> events, but not the <xref:System.Windows.Media.Animation.Timeline.Completed> event.
<xref:System.Windows.Media.Animation.StopStoryboard> does not reference a <xref:System.Windows.Media.Animation.Storyboard> directly. Rather, <xref:System.Windows.Media.Animation.StopStoryboard> must reference the <xref:System.Windows.Media.Animation.BeginStoryboard.Name%2A> of the <xref:System.Windows.Media.Animation.BeginStoryboard> that controls the <xref:System.Windows.Media.Animation.Storyboard>. See [How to: Use Event Triggers to Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-use-event-triggers-to-control-a-storyboard-after-it-starts) for an example.
## Pause, Resume, Stop, or Otherwise Control a Storyboard Interactively
To be able to pause, resume, or otherwise control a <xref:System.Windows.Media.Animation.BeginStoryboard.Storyboard%2A> interactively, set the <xref:System.Windows.Media.Animation.BeginStoryboard.Name%2A> property of its <xref:System.Windows.Media.Animation.BeginStoryboard> and use a <xref:System.Windows.Media.Animation.ControllableStoryboardAction> object (such as <xref:System.Windows.Media.Animation.PauseStoryboard>, <xref:System.Windows.Media.Animation.ResumeStoryboard>, or <xref:System.Windows.Media.Animation.StopStoryboard>) to control it by referencing its <xref:System.Windows.Media.Animation.BeginStoryboard.Name%2A>. If the <xref:System.Windows.Media.Animation.BeginStoryboard.Name%2A> of <xref:System.Windows.Media.Animation.BeginStoryboard> is unspecified, the <xref:System.Windows.Media.Animation.BeginStoryboard.Storyboard%2A> cannot be interactively controlled after it is begun. See [How to: Use Event Triggers to Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-use-event-triggers-to-control-a-storyboard-after-it-starts) for more information.
]]></format>
</remarks>
<altmember cref="T:System.Windows.Media.Animation.ResumeStoryboard" />
<altmember cref="T:System.Windows.Media.Animation.BeginStoryboard" />
<altmember cref="T:System.Windows.Media.Animation.PauseStoryboard" />
<altmember cref="T:System.Windows.Media.Animation.SkipStoryboardToFill" />
<altmember cref="T:System.Windows.Media.Animation.SetStoryboardSpeedRatio" />
<altmember cref="T:System.Windows.EventTrigger" />
<altmember cref="T:System.Windows.Trigger" />
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public StopStoryboard ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Animation.StopStoryboard.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 StopStoryboard();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationFramework</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Windows.Media.Animation.StopStoryboard" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>