/
Int32AnimationBase.xml
312 lines (279 loc) · 22.8 KB
/
Int32AnimationBase.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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
<Type Name="Int32AnimationBase" FullName="System.Windows.Media.Animation.Int32AnimationBase">
<TypeSignature Language="C#" Value="public abstract class Int32AnimationBase : System.Windows.Media.Animation.AnimationTimeline" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit Int32AnimationBase extends System.Windows.Media.Animation.AnimationTimeline" />
<TypeSignature Language="DocId" Value="T:System.Windows.Media.Animation.Int32AnimationBase" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class Int32AnimationBase
Inherits AnimationTimeline" />
<TypeSignature Language="F#" Value="type Int32AnimationBase = class
 inherit AnimationTimeline" />
<TypeSignature Language="C++ CLI" Value="public ref class Int32AnimationBase abstract : System::Windows::Media::Animation::AnimationTimeline" />
<AssemblyInfo>
<AssemblyName>PresentationCore</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.AnimationTimeline</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Abstract class that, when implemented, animates a <see cref="T:System.Int32" /> value.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following code example demonstrates how to use the <xref:System.Windows.Media.Animation.DoubleAnimationUsingKeyFrames> class in Extensible Application Markup Language (XAML), but generically shows how to use other derived classes such as <xref:System.Windows.Media.Animation.Int32AnimationUsingKeyFrames>.
:::code language="xaml" source="~/snippets/csharp/System.Windows.Media.Animation/BooleanAnimationBase/Overview/AltDoubleAnimationUsingKeyFramesExample.xaml" id="Snippetaltdoubleanimationusingkeyframeswholepage":::
]]></format>
</remarks>
<block subset="none" type="overrides">
<para>See the [Custom Animations Overview](/dotnet/framework/wpf/graphics-multimedia/custom-animations-overview) for information about extending animation classes.</para>
</block>
<altmember cref="T:System.Windows.Media.Animation.Int32AnimationUsingKeyFrames" />
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Int32AnimationBase ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Animation.Int32AnimationBase.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberSignature Language="C++ CLI" Value="protected:
 Int32AnimationBase();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</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.Int32AnimationBase" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Clone">
<MemberSignature Language="C#" Value="public System.Windows.Media.Animation.Int32AnimationBase Clone ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Windows.Media.Animation.Int32AnimationBase Clone() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Animation.Int32AnimationBase.Clone" />
<MemberSignature Language="VB.NET" Value="Public Function Clone () As Int32AnimationBase" />
<MemberSignature Language="F#" Value="override this.Clone : unit -> System.Windows.Media.Animation.Int32AnimationBase" Usage="int32AnimationBase.Clone " />
<MemberSignature Language="C++ CLI" Value="public:
 System::Windows::Media::Animation::Int32AnimationBase ^ Clone();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</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>
<ReturnValue>
<ReturnType>System.Windows.Media.Animation.Int32AnimationBase</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Creates a modifiable clone of this <see cref="T:System.Windows.Media.Animation.Int32AnimationBase" />, making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values.</summary>
<returns>A modifiable clone of the current object. The cloned object's <see cref="P:System.Windows.Freezable.IsFrozen" /> property will be <see langword="false" /> even if the source's <see cref="P:System.Windows.Freezable.IsFrozen" /> property was <see langword="true" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This method is used to produce modifiable copies of frozen <xref:System.Windows.Freezable> objects (or any <xref:System.Windows.Freezable> object). For convenience, this method shadows the inherited version with a strongly typed implementation.
For more information, see <xref:System.Windows.Freezable.Clone%2A?displayProperty=nameWithType>.
]]></format>
</remarks>
</Docs>
</Member>
<MemberGroup MemberName="GetCurrentValue">
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Gets the current value of the animation.</summary>
</Docs>
</MemberGroup>
<Member MemberName="GetCurrentValue">
<MemberSignature Language="C#" Value="public int GetCurrentValue (int defaultOriginValue, int defaultDestinationValue, System.Windows.Media.Animation.AnimationClock animationClock);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance int32 GetCurrentValue(int32 defaultOriginValue, int32 defaultDestinationValue, class System.Windows.Media.Animation.AnimationClock animationClock) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Animation.Int32AnimationBase.GetCurrentValue(System.Int32,System.Int32,System.Windows.Media.Animation.AnimationClock)" />
<MemberSignature Language="VB.NET" Value="Public Function GetCurrentValue (defaultOriginValue As Integer, defaultDestinationValue As Integer, animationClock As AnimationClock) As Integer" />
<MemberSignature Language="F#" Value="override this.GetCurrentValue : int * int * System.Windows.Media.Animation.AnimationClock -> int" Usage="int32AnimationBase.GetCurrentValue (defaultOriginValue, defaultDestinationValue, animationClock)" />
<MemberSignature Language="C++ CLI" Value="public:
 int GetCurrentValue(int defaultOriginValue, int defaultDestinationValue, System::Windows::Media::Animation::AnimationClock ^ animationClock);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</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>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="defaultOriginValue" Type="System.Int32" />
<Parameter Name="defaultDestinationValue" Type="System.Int32" />
<Parameter Name="animationClock" Type="System.Windows.Media.Animation.AnimationClock" />
</Parameters>
<Docs>
<param name="defaultOriginValue">The origin value provided to the animation if the animation does not have its own start value.</param>
<param name="defaultDestinationValue">The destination value provided to the animation if the animation does not have its own destination value.</param>
<param name="animationClock">The <see cref="T:System.Windows.Media.Animation.AnimationClock" /> which can generate the <see cref="P:System.Windows.Media.Animation.Clock.CurrentTime" /> or <see cref="P:System.Windows.Media.Animation.Clock.CurrentProgress" /> value to be used by the animation to generate its output value.</param>
<summary>Gets the current value of the animation.</summary>
<returns>The value this animation believes should be the current value for the property.</returns>
<remarks>
<format type="text/markdown"><. For more information about creating custom animation types, see the [Custom Animations Overview](/dotnet/framework/wpf/graphics-multimedia/custom-animations-overview).
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="GetCurrentValue">
<MemberSignature Language="C#" Value="public override sealed object GetCurrentValue (object defaultOriginValue, object defaultDestinationValue, System.Windows.Media.Animation.AnimationClock animationClock);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance object GetCurrentValue(object defaultOriginValue, object defaultDestinationValue, class System.Windows.Media.Animation.AnimationClock animationClock) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Animation.Int32AnimationBase.GetCurrentValue(System.Object,System.Object,System.Windows.Media.Animation.AnimationClock)" />
<MemberSignature Language="VB.NET" Value="Public Overrides NotOverridable Function GetCurrentValue (defaultOriginValue As Object, defaultDestinationValue As Object, animationClock As AnimationClock) As Object" />
<MemberSignature Language="F#" Value="override this.GetCurrentValue : obj * obj * System.Windows.Media.Animation.AnimationClock -> obj" Usage="int32AnimationBase.GetCurrentValue (defaultOriginValue, defaultDestinationValue, animationClock)" />
<MemberSignature Language="C++ CLI" Value="public:
 override System::Object ^ GetCurrentValue(System::Object ^ defaultOriginValue, System::Object ^ defaultDestinationValue, System::Windows::Media::Animation::AnimationClock ^ animationClock);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</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>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="defaultOriginValue" Type="System.Object" />
<Parameter Name="defaultDestinationValue" Type="System.Object" />
<Parameter Name="animationClock" Type="System.Windows.Media.Animation.AnimationClock" />
</Parameters>
<Docs>
<param name="defaultOriginValue">The origin value provided to the animation if the animation does not have its own start value.</param>
<param name="defaultDestinationValue">The destination value provided to the animation if the animation does not have its own destination value.</param>
<param name="animationClock">The <see cref="T:System.Windows.Media.Animation.AnimationClock" /> which can generate the <see cref="P:System.Windows.Media.Animation.Clock.CurrentTime" /> or <see cref="P:System.Windows.Media.Animation.Clock.CurrentProgress" /> value to be used by the animation to generate its output value.</param>
<summary>Gets the current value of the animation.</summary>
<returns>The value this animation believes should be the current value for the property.</returns>
<remarks>
<format type="text/markdown"><. For more information about creating custom animation types, see the [Custom Animations Overview](/dotnet/framework/wpf/graphics-multimedia/custom-animations-overview).
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="GetCurrentValueCore">
<MemberSignature Language="C#" Value="protected abstract int GetCurrentValueCore (int defaultOriginValue, int defaultDestinationValue, System.Windows.Media.Animation.AnimationClock animationClock);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance int32 GetCurrentValueCore(int32 defaultOriginValue, int32 defaultDestinationValue, class System.Windows.Media.Animation.AnimationClock animationClock) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Animation.Int32AnimationBase.GetCurrentValueCore(System.Int32,System.Int32,System.Windows.Media.Animation.AnimationClock)" />
<MemberSignature Language="VB.NET" Value="Protected MustOverride Function GetCurrentValueCore (defaultOriginValue As Integer, defaultDestinationValue As Integer, animationClock As AnimationClock) As Integer" />
<MemberSignature Language="F#" Value="abstract member GetCurrentValueCore : int * int * System.Windows.Media.Animation.AnimationClock -> int" Usage="int32AnimationBase.GetCurrentValueCore (defaultOriginValue, defaultDestinationValue, animationClock)" />
<MemberSignature Language="C++ CLI" Value="protected:
 abstract int GetCurrentValueCore(int defaultOriginValue, int defaultDestinationValue, System::Windows::Media::Animation::AnimationClock ^ animationClock);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</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>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="defaultOriginValue" Type="System.Int32" />
<Parameter Name="defaultDestinationValue" Type="System.Int32" />
<Parameter Name="animationClock" Type="System.Windows.Media.Animation.AnimationClock" />
</Parameters>
<Docs>
<param name="defaultOriginValue">The suggested origin value, used if the animation does not have its own explicitly set start value.</param>
<param name="defaultDestinationValue">The suggested destination value, used if the animation does not have its own explicitly set end value.</param>
<param name="animationClock">An <see cref="T:System.Windows.Media.Animation.AnimationClock" /> that generates the <see cref="P:System.Windows.Media.Animation.Clock.CurrentTime" /> or <see cref="P:System.Windows.Media.Animation.Clock.CurrentProgress" /> used by the host animation.</param>
<summary>Calculates a value that represents the current value of the property being animated, as determined by the host animation.</summary>
<returns>The calculated value of the property, as determined by the current animation.</returns>
<remarks>
<format type="text/markdown"><. For more information about creating custom animation types, see the [Custom Animations Overview](/dotnet/framework/wpf/graphics-multimedia/custom-animations-overview).
]]></format>
</remarks>
<altmember cref="T:System.Windows.Media.Animation.AnimationClock" />
</Docs>
</Member>
<Member MemberName="TargetPropertyType">
<MemberSignature Language="C#" Value="public override sealed Type TargetPropertyType { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Type TargetPropertyType" />
<MemberSignature Language="DocId" Value="P:System.Windows.Media.Animation.Int32AnimationBase.TargetPropertyType" />
<MemberSignature Language="VB.NET" Value="Public Overrides NotOverridable ReadOnly Property TargetPropertyType As Type" />
<MemberSignature Language="F#" Value="member this.TargetPropertyType : Type" Usage="System.Windows.Media.Animation.Int32AnimationBase.TargetPropertyType" />
<MemberSignature Language="C++ CLI" Value="public:
 property Type ^ TargetPropertyType { Type ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</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>
<ReturnValue>
<ReturnType>System.Type</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the type of value this animation generates.</summary>
<value>The type of value produced by this animation.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>