/
InertiaTranslationBehavior.xml
198 lines (177 loc) · 13.2 KB
/
InertiaTranslationBehavior.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
<Type Name="InertiaTranslationBehavior" FullName="System.Windows.Input.InertiaTranslationBehavior">
<TypeSignature Language="C#" Value="public class InertiaTranslationBehavior" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit InertiaTranslationBehavior extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.Windows.Input.InertiaTranslationBehavior" />
<TypeSignature Language="VB.NET" Value="Public Class InertiaTranslationBehavior" />
<TypeSignature Language="F#" Value="type InertiaTranslationBehavior = class" />
<TypeSignature Language="C++ CLI" Value="public ref class InertiaTranslationBehavior" />
<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.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Controls deceleration on a translation manipulation during inertia.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Windows.Input.InertiaTranslationBehavior> class specifies how a translation manipulation behaves when it is inertia. Use the <xref:System.Windows.Input.ManipulationInertiaStartingEventArgs.TranslationBehavior%2A> property in the <xref:System.Windows.UIElement.ManipulationInertiaStarting> event to do the following:
- Specify the initial velocity of the inertia when it begins by setting the <xref:System.Windows.Input.InertiaTranslationBehavior.InitialVelocity%2A> property.
- Specify the desired position of the manipulation when inertia ends by setting the <xref:System.Windows.Input.InertiaTranslationBehavior.DesiredDisplacement%2A> property.
- Specify the desired deceleration of the inertia by setting the <xref:System.Windows.Input.InertiaTranslationBehavior.DesiredDeceleration%2A> property.
Set either the <xref:System.Windows.Input.InertiaTranslationBehavior.DesiredDisplacement%2A> or the <xref:System.Windows.Input.InertiaTranslationBehavior.DesiredDeceleration%2A>, but not both. When you set one of these properties, the other property is changed to <xref:System.Double.NaN?displayProperty=nameWithType> if it has a value.
For more information about manipulations, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). For an example of an application that responds to manipulations, see [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application).
## Examples
The following example shows the <xref:System.Windows.UIElement.ManipulationInertiaStarting> event handler and sets the desired deceleration for translation, expansion, and rotation that is used during inertia. This example is part of a larger example in [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application).
:::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/IsManipulationEnabled/mainwindow.xaml.cs" id="Snippetmanipulationinertiastarting":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/basicmanipulation/visualbasic/mainwindow.xaml.vb" id="Snippetmanipulationinertiastarting":::
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public InertiaTranslationBehavior ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Input.InertiaTranslationBehavior.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 InertiaTranslationBehavior();" />
<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 />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Windows.Input.InertiaTranslationBehavior" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DesiredDeceleration">
<MemberSignature Language="C#" Value="public double DesiredDeceleration { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance float64 DesiredDeceleration" />
<MemberSignature Language="DocId" Value="P:System.Windows.Input.InertiaTranslationBehavior.DesiredDeceleration" />
<MemberSignature Language="VB.NET" Value="Public Property DesiredDeceleration As Double" />
<MemberSignature Language="F#" Value="member this.DesiredDeceleration : double with get, set" Usage="System.Windows.Input.InertiaTranslationBehavior.DesiredDeceleration" />
<MemberSignature Language="C++ CLI" Value="public:
 property double DesiredDeceleration { double get(); void set(double 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>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the rate the linear movement slows in device-independent units (1/96th inch per unit) per squared millisecond.</summary>
<value>The rate the linear movement slows in device-independent units (1/96th inch per unit) per squared millisecond. The default is <see cref="F:System.Double.NaN" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use the <xref:System.Windows.Input.InertiaTranslationBehavior.DesiredDeceleration%2A> property to specify the desired deceleration of the inertia. Set either the <xref:System.Windows.Input.InertiaTranslationBehavior.DesiredDisplacement%2A> or the <xref:System.Windows.Input.InertiaTranslationBehavior.DesiredDeceleration%2A>, but not both. When you set one of these properties, the other property is changed to <xref:System.Double.NaN?displayProperty=nameWithType> if it has a value.
For more information about manipulations, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). For an example of an application that responds to manipulations, see [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application).
]]></format>
</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">The property is set to infinity.
-or-
The property is set to <see cref="F:System.Double.NaN" />.</exception>
</Docs>
</Member>
<Member MemberName="DesiredDisplacement">
<MemberSignature Language="C#" Value="public double DesiredDisplacement { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance float64 DesiredDisplacement" />
<MemberSignature Language="DocId" Value="P:System.Windows.Input.InertiaTranslationBehavior.DesiredDisplacement" />
<MemberSignature Language="VB.NET" Value="Public Property DesiredDisplacement As Double" />
<MemberSignature Language="F#" Value="member this.DesiredDisplacement : double with get, set" Usage="System.Windows.Input.InertiaTranslationBehavior.DesiredDisplacement" />
<MemberSignature Language="C++ CLI" Value="public:
 property double DesiredDisplacement { double get(); void set(double 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>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the linear movement of the manipulation at the end of inertia.</summary>
<value>The linear movement of the manipulation at the end of inertia. The default is <see cref="F:System.Double.NaN" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use the <xref:System.Windows.Input.InertiaTranslationBehavior.DesiredDisplacement%2A> property to specify the desired position of the manipulation when inertia ends. Set either the <xref:System.Windows.Input.InertiaTranslationBehavior.DesiredDisplacement%2A> or the <xref:System.Windows.Input.InertiaTranslationBehavior.DesiredDeceleration%2A>, but not both. When you set one of these properties, the other property is changed to <xref:System.Double.NaN?displayProperty=nameWithType> if it has a value.
For more information about manipulations, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). For an example of an application that responds to manipulations, see [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application).
]]></format>
</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">The property is set to infinity.
-or-
The property is set to <see cref="F:System.Double.NaN" />.</exception>
</Docs>
</Member>
<Member MemberName="InitialVelocity">
<MemberSignature Language="C#" Value="public System.Windows.Vector InitialVelocity { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Windows.Vector InitialVelocity" />
<MemberSignature Language="DocId" Value="P:System.Windows.Input.InertiaTranslationBehavior.InitialVelocity" />
<MemberSignature Language="VB.NET" Value="Public Property InitialVelocity As Vector" />
<MemberSignature Language="F#" Value="member this.InitialVelocity : System.Windows.Vector with get, set" Usage="System.Windows.Input.InertiaTranslationBehavior.InitialVelocity" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Windows::Vector InitialVelocity { System::Windows::Vector get(); void set(System::Windows::Vector 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>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Windows.Vector</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the initial rate of linear movement at the start of the inertia phase.</summary>
<value>The initial rate of linear movement at the start of the inertia phase.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>