/
EasingDecimalKeyFrame.xml
282 lines (273 loc) · 19.1 KB
/
EasingDecimalKeyFrame.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
<Type Name="EasingDecimalKeyFrame" FullName="System.Windows.Media.Animation.EasingDecimalKeyFrame">
<TypeSignature Language="C#" Value="public class EasingDecimalKeyFrame : System.Windows.Media.Animation.DecimalKeyFrame" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit EasingDecimalKeyFrame extends System.Windows.Media.Animation.DecimalKeyFrame" />
<TypeSignature Language="DocId" Value="T:System.Windows.Media.Animation.EasingDecimalKeyFrame" />
<TypeSignature Language="VB.NET" Value="Public Class EasingDecimalKeyFrame
Inherits DecimalKeyFrame" />
<TypeSignature Language="F#" Value="type EasingDecimalKeyFrame = class
 inherit DecimalKeyFrame" />
<TypeSignature Language="C++ CLI" Value="public ref class EasingDecimalKeyFrame : System::Windows::Media::Animation::DecimalKeyFrame" />
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<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.DecimalKeyFrame</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>An abstract class that enables you to associate easing functions with a <see cref="T:System.Windows.Media.Animation.DecimalAnimationUsingKeyFrames" /> key frame animation.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
For an example of using an object similar to this one, see <xref:System.Windows.Media.Animation.EasingDoubleKeyFrame>.
This class is used as part of a <xref:System.Windows.Media.Animation.DecimalKeyFrameCollection> in conjunction with a <xref:System.Windows.Media.Animation.DecimalAnimationUsingKeyFrames> to animate a <xref:System.Decimal> property value along a set of key frames. This <xref:System.Windows.Media.Animation.DecimalKeyFrame> interpolates between the <xref:System.Decimal> value of the previous key frame and its own value linearly with an easing function to produce its output value.
]]></format>
</remarks>
<altmember cref="T:System.Windows.Media.Animation.IEasingFunction" />
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public EasingDecimalKeyFrame ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Animation.EasingDecimalKeyFrame.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 EasingDecimalKeyFrame();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<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.EasingDecimalKeyFrame" /> class.</summary>
<remarks>To be added.</remarks>
<altmember cref="T:System.Windows.Media.Animation.IEasingFunction" />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public EasingDecimalKeyFrame (decimal value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.Decimal value) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Animation.EasingDecimalKeyFrame.#ctor(System.Decimal)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (value As Decimal)" />
<MemberSignature Language="F#" Value="new System.Windows.Media.Animation.EasingDecimalKeyFrame : decimal -> System.Windows.Media.Animation.EasingDecimalKeyFrame" Usage="new System.Windows.Media.Animation.EasingDecimalKeyFrame value" />
<MemberSignature Language="C++ CLI" Value="public:
 EasingDecimalKeyFrame(System::Decimal value);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<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>
<Parameters>
<Parameter Name="value" Type="System.Decimal" />
</Parameters>
<Docs>
<param name="value">The initial value.</param>
<summary>Initializes a new instance of the <see cref="T:System.Windows.Media.Animation.EasingDecimalKeyFrame" /> class with the specified value.</summary>
<remarks>To be added.</remarks>
<altmember cref="T:System.Windows.Media.Animation.IEasingFunction" />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public EasingDecimalKeyFrame (decimal value, System.Windows.Media.Animation.KeyTime keyTime);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.Decimal value, valuetype System.Windows.Media.Animation.KeyTime keyTime) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Animation.EasingDecimalKeyFrame.#ctor(System.Decimal,System.Windows.Media.Animation.KeyTime)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (value As Decimal, keyTime As KeyTime)" />
<MemberSignature Language="F#" Value="new System.Windows.Media.Animation.EasingDecimalKeyFrame : decimal * System.Windows.Media.Animation.KeyTime -> System.Windows.Media.Animation.EasingDecimalKeyFrame" Usage="new System.Windows.Media.Animation.EasingDecimalKeyFrame (value, keyTime)" />
<MemberSignature Language="C++ CLI" Value="public:
 EasingDecimalKeyFrame(System::Decimal value, System::Windows::Media::Animation::KeyTime keyTime);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<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>
<Parameters>
<Parameter Name="value" Type="System.Decimal" />
<Parameter Name="keyTime" Type="System.Windows.Media.Animation.KeyTime" />
</Parameters>
<Docs>
<param name="value">The initial value.</param>
<param name="keyTime">The initial key time.</param>
<summary>Initializes a new instance of the <see cref="T:System.Windows.Media.Animation.EasingDecimalKeyFrame" /> class with the specified value and key time.</summary>
<remarks>To be added.</remarks>
<altmember cref="T:System.Windows.Media.Animation.IEasingFunction" />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public EasingDecimalKeyFrame (decimal value, System.Windows.Media.Animation.KeyTime keyTime, System.Windows.Media.Animation.IEasingFunction easingFunction);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.Decimal value, valuetype System.Windows.Media.Animation.KeyTime keyTime, class System.Windows.Media.Animation.IEasingFunction easingFunction) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Animation.EasingDecimalKeyFrame.#ctor(System.Decimal,System.Windows.Media.Animation.KeyTime,System.Windows.Media.Animation.IEasingFunction)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (value As Decimal, keyTime As KeyTime, easingFunction As IEasingFunction)" />
<MemberSignature Language="F#" Value="new System.Windows.Media.Animation.EasingDecimalKeyFrame : decimal * System.Windows.Media.Animation.KeyTime * System.Windows.Media.Animation.IEasingFunction -> System.Windows.Media.Animation.EasingDecimalKeyFrame" Usage="new System.Windows.Media.Animation.EasingDecimalKeyFrame (value, keyTime, easingFunction)" />
<MemberSignature Language="C++ CLI" Value="public:
 EasingDecimalKeyFrame(System::Decimal value, System::Windows::Media::Animation::KeyTime keyTime, System::Windows::Media::Animation::IEasingFunction ^ easingFunction);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<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>
<Parameters>
<Parameter Name="value" Type="System.Decimal" />
<Parameter Name="keyTime" Type="System.Windows.Media.Animation.KeyTime" />
<Parameter Name="easingFunction" Type="System.Windows.Media.Animation.IEasingFunction" />
</Parameters>
<Docs>
<param name="value">The initial value.</param>
<param name="keyTime">The initial key time.</param>
<param name="easingFunction">The easing function.</param>
<summary>Initializes a new instance of the <see cref="T:System.Windows.Media.Animation.EasingDecimalKeyFrame" /> class with the specified value, key time, and easing function.</summary>
<remarks>To be added.</remarks>
<altmember cref="T:System.Windows.Media.Animation.IEasingFunction" />
</Docs>
</Member>
<Member MemberName="CreateInstanceCore">
<MemberSignature Language="C#" Value="protected override System.Windows.Freezable CreateInstanceCore ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance class System.Windows.Freezable CreateInstanceCore() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Animation.EasingDecimalKeyFrame.CreateInstanceCore" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Function CreateInstanceCore () As Freezable" />
<MemberSignature Language="F#" Value="override this.CreateInstanceCore : unit -> System.Windows.Freezable" Usage="easingDecimalKeyFrame.CreateInstanceCore " />
<MemberSignature Language="C++ CLI" Value="protected:
 override System::Windows::Freezable ^ CreateInstanceCore();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<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.Freezable</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Creates a new instance of the <see cref="T:System.Windows.Freezable" /> derived class. When creating a derived class, you must override this method.</summary>
<returns>The new instance.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Animation classes inherit indirectly from <xref:System.Windows.Freezable>. Because of this, you need to override the <xref:System.Windows.Media.Animation.BackEase.CreateInstanceCore%2A> method to construct a custom animation object.
## Examples
The following example shows a typical implementation of <xref:System.Windows.Freezable.CreateInstanceCore%2A>.
:::code language="csharp" source="~/snippets/csharp/System.Windows/Freezable/CreateInstanceCore/freezablesample.cs" id="Snippetcreateinstancecoreexample":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample":::
]]></format>
</remarks>
<altmember cref="T:System.Windows.Media.Animation.IEasingFunction" />
</Docs>
</Member>
<Member MemberName="EasingFunction">
<MemberSignature Language="C#" Value="public System.Windows.Media.Animation.IEasingFunction EasingFunction { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Windows.Media.Animation.IEasingFunction EasingFunction" />
<MemberSignature Language="DocId" Value="P:System.Windows.Media.Animation.EasingDecimalKeyFrame.EasingFunction" />
<MemberSignature Language="VB.NET" Value="Public Property EasingFunction As IEasingFunction" />
<MemberSignature Language="F#" Value="member this.EasingFunction : System.Windows.Media.Animation.IEasingFunction with get, set" Usage="System.Windows.Media.Animation.EasingDecimalKeyFrame.EasingFunction" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Windows::Media::Animation::IEasingFunction ^ EasingFunction { System::Windows::Media::Animation::IEasingFunction ^ get(); void set(System::Windows::Media::Animation::IEasingFunction ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<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.IEasingFunction</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the easing function applied to the key frame.</summary>
<value>The easing function applied to the key frame.</value>
<remarks>To be added.</remarks>
<altmember cref="T:System.Windows.Media.Animation.IEasingFunction" />
</Docs>
</Member>
<Member MemberName="EasingFunctionProperty">
<MemberSignature Language="C#" Value="public static readonly System.Windows.DependencyProperty EasingFunctionProperty;" />
<MemberSignature Language="ILAsm" Value=".field public static initonly class System.Windows.DependencyProperty EasingFunctionProperty" />
<MemberSignature Language="DocId" Value="F:System.Windows.Media.Animation.EasingDecimalKeyFrame.EasingFunctionProperty" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly EasingFunctionProperty As DependencyProperty " />
<MemberSignature Language="F#" Value=" staticval mutable EasingFunctionProperty : System.Windows.DependencyProperty" Usage="System.Windows.Media.Animation.EasingDecimalKeyFrame.EasingFunctionProperty" />
<MemberSignature Language="C++ CLI" Value="public: static initonly System::Windows::DependencyProperty ^ EasingFunctionProperty;" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<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.DependencyProperty</ReturnType>
</ReturnValue>
<Docs>
<summary>Identifies the <see cref="P:System.Windows.Media.Animation.EasingDecimalKeyFrame.EasingFunction" /> dependency property.</summary>
<remarks>To be added.</remarks>
<altmember cref="T:System.Windows.Media.Animation.IEasingFunction" />
</Docs>
</Member>
<Member MemberName="InterpolateValueCore">
<MemberSignature Language="C#" Value="protected override decimal InterpolateValueCore (decimal baseValue, double keyFrameProgress);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance valuetype System.Decimal InterpolateValueCore(valuetype System.Decimal baseValue, float64 keyFrameProgress) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Animation.EasingDecimalKeyFrame.InterpolateValueCore(System.Decimal,System.Double)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Function InterpolateValueCore (baseValue As Decimal, keyFrameProgress As Double) As Decimal" />
<MemberSignature Language="F#" Value="override this.InterpolateValueCore : decimal * double -> decimal" Usage="easingDecimalKeyFrame.InterpolateValueCore (baseValue, keyFrameProgress)" />
<MemberSignature Language="C++ CLI" Value="protected:
 override System::Decimal InterpolateValueCore(System::Decimal baseValue, double keyFrameProgress);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<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.Decimal</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="baseValue" Type="System.Decimal" />
<Parameter Name="keyFrameProgress" Type="System.Double" />
</Parameters>
<Docs>
<param name="baseValue">The value to animate from.</param>
<param name="keyFrameProgress">A value between 0.0 and 1.0, inclusive, that specifies the percentage of time that has elapsed for this key frame.</param>
<summary>Interpolates, according to the easing function used, between the previous key frame value and the value of the current key frame, using the supplied progress increment.</summary>
<returns>The output value of this key frame given the specified base value and progress.</returns>
<remarks>To be added.</remarks>
<altmember cref="T:System.Windows.Media.Animation.IEasingFunction" />
</Docs>
</Member>
</Members>
</Type>