/
RawStylusInput.xml
281 lines (254 loc) · 17.6 KB
/
RawStylusInput.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
<Type Name="RawStylusInput" FullName="System.Windows.Input.StylusPlugIns.RawStylusInput">
<TypeSignature Language="C#" Value="public class RawStylusInput" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit RawStylusInput extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.Windows.Input.StylusPlugIns.RawStylusInput" />
<TypeSignature Language="VB.NET" Value="Public Class RawStylusInput" />
<TypeSignature Language="F#" Value="type RawStylusInput = class" />
<TypeSignature Language="C++ CLI" Value="public ref class RawStylusInput" />
<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.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Provides information about input from a <see cref="T:System.Windows.Input.StylusDevice" /> to a <see cref="T:System.Windows.Input.StylusPlugIns.StylusPlugIn" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use the <xref:System.Windows.Input.StylusPlugIns.RawStylusInput> to get information about the input the <xref:System.Windows.Input.StylusPlugIns.StylusPlugIn> receives when the user moves the stylus.
## Examples
The following example creates a <xref:System.Windows.Input.StylusPlugIns.StylusPlugIn> that checks for the <xref:System.Windows.Ink.ApplicationGesture.Down> gesture. The <xref:System.Windows.Input.StylusPlugIns.StylusPlugIn> calls <xref:System.Windows.Input.StylusPlugIns.RawStylusInput.NotifyWhenProcessed%2A> in <xref:System.Windows.Input.StylusPlugIns.StylusPlugIn.OnStylusUp%2A> to subscribe to the <xref:System.Windows.Input.StylusPlugIns.StylusPlugIn.OnStylusUpProcessed%2A> method, which is called from the application thread.
:::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/StylusPlugIns/RecognizerPlugin.cs" id="Snippet12":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/StylusPluginSamples/VisualBasic/RecognizerPlugin.vb" id="Snippet12":::
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName="GetStylusPoints">
<MemberSignature Language="C#" Value="public System.Windows.Input.StylusPointCollection GetStylusPoints ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Windows.Input.StylusPointCollection GetStylusPoints() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Input.StylusPlugIns.RawStylusInput.GetStylusPoints" />
<MemberSignature Language="VB.NET" Value="Public Function GetStylusPoints () As StylusPointCollection" />
<MemberSignature Language="F#" Value="member this.GetStylusPoints : unit -> System.Windows.Input.StylusPointCollection" Usage="rawStylusInput.GetStylusPoints " />
<MemberSignature Language="C++ CLI" Value="public:
 System::Windows::Input::StylusPointCollection ^ GetStylusPoints();" />
<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.Input.StylusPointCollection</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Gets the stylus points that are collected from the stylus.</summary>
<returns>The stylus points that are collected from the stylus.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following example demonstrates how to change the stylus points in the <xref:System.Windows.Input.StylusPlugIns.StylusPlugIn.OnStylusDown%2A> method. To create a <xref:System.Windows.Input.StylusPlugIns.StylusPlugIn> that restricts ink to a certain area, see the <xref:System.Windows.Input.StylusPlugIns.StylusPlugIn> overview.
:::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/StylusPlugIns/FilterPlugin.cs" id="Snippet8":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/StylusPluginSamples/VisualBasic/FilterPlugin.vb" id="Snippet8":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="NotifyWhenProcessed">
<MemberSignature Language="C#" Value="public void NotifyWhenProcessed (object callbackData);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void NotifyWhenProcessed(object callbackData) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Input.StylusPlugIns.RawStylusInput.NotifyWhenProcessed(System.Object)" />
<MemberSignature Language="VB.NET" Value="Public Sub NotifyWhenProcessed (callbackData As Object)" />
<MemberSignature Language="F#" Value="member this.NotifyWhenProcessed : obj -> unit" Usage="rawStylusInput.NotifyWhenProcessed callbackData" />
<MemberSignature Language="C++ CLI" Value="public:
 void NotifyWhenProcessed(System::Object ^ callbackData);" />
<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.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="callbackData" Type="System.Object" />
</Parameters>
<Docs>
<param name="callbackData">The data to pass to the application thread.</param>
<summary>Subscribes to the application thread's corresponding stylus methods.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The pen's input is routed to an element's <xref:System.Windows.Input.StylusPlugIns.StylusPlugIn> on the pen thread. Because accurate hit-testing cannot be performed on the pen thread, some elements might occasionally receive stylus input intended for other elements. If you need to be sure the input was routed correctly before performing an operation, call the <xref:System.Windows.Input.StylusPlugIns.RawStylusInput.NotifyWhenProcessed%2A> method in the method that occurs on the pen thread. The following table lists where to call <xref:System.Windows.Input.StylusPlugIns.RawStylusInput.NotifyWhenProcessed%2A> to subscribe to the application thread's method.
|Call <xref:System.Windows.Input.StylusPlugIns.RawStylusInput.NotifyWhenProcessed%2A> in this method|To subscribe to this method|
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|
|<xref:System.Windows.Input.StylusPlugIns.StylusPlugIn.OnStylusDown%2A>|<xref:System.Windows.Input.StylusPlugIns.StylusPlugIn.OnStylusDownProcessed%2A>|
|<xref:System.Windows.Input.StylusPlugIns.StylusPlugIn.OnStylusMove%2A>|<xref:System.Windows.Input.StylusPlugIns.StylusPlugIn.OnStylusMoveProcessed%2A>|
|<xref:System.Windows.Input.StylusPlugIns.StylusPlugIn.OnStylusUp%2A>|<xref:System.Windows.Input.StylusPlugIns.StylusPlugIn.OnStylusUpProcessed%2A>|
## Examples
The following example creates a <xref:System.Windows.Input.StylusPlugIns.StylusPlugIn> that checks for the <xref:System.Windows.Ink.ApplicationGesture.Down> gesture. The <xref:System.Windows.Input.StylusPlugIns.StylusPlugIn> calls <xref:System.Windows.Input.StylusPlugIns.RawStylusInput.NotifyWhenProcessed%2A> in <xref:System.Windows.Input.StylusPlugIns.StylusPlugIn.OnStylusUp%2A> to subscribe to the <xref:System.Windows.Input.StylusPlugIns.StylusPlugIn.OnStylusUpProcessed%2A> method, which is called from the application thread.
:::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/StylusPlugIns/RecognizerPlugin.cs" id="Snippet12":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/StylusPluginSamples/VisualBasic/RecognizerPlugin.vb" id="Snippet12":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="SetStylusPoints">
<MemberSignature Language="C#" Value="public void SetStylusPoints (System.Windows.Input.StylusPointCollection stylusPoints);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetStylusPoints(class System.Windows.Input.StylusPointCollection stylusPoints) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Input.StylusPlugIns.RawStylusInput.SetStylusPoints(System.Windows.Input.StylusPointCollection)" />
<MemberSignature Language="VB.NET" Value="Public Sub SetStylusPoints (stylusPoints As StylusPointCollection)" />
<MemberSignature Language="F#" Value="member this.SetStylusPoints : System.Windows.Input.StylusPointCollection -> unit" Usage="rawStylusInput.SetStylusPoints stylusPoints" />
<MemberSignature Language="C++ CLI" Value="public:
 void SetStylusPoints(System::Windows::Input::StylusPointCollection ^ stylusPoints);" />
<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>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1">
<AttributeName Language="C#">[System.Security.SecuritySafeCritical]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecuritySafeCritical>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="stylusPoints" Type="System.Windows.Input.StylusPointCollection" />
</Parameters>
<Docs>
<param name="stylusPoints">The stylus points to pass to the application thread.</param>
<summary>Sets the stylus points that are passed to the application thread.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Events such as <xref:System.Windows.UIElement.StylusDown> and <xref:System.Windows.UIElement.StylusMove>, can get the <xref:System.Windows.Input.StylusPointCollection> set by <xref:System.Windows.Input.StylusPlugIns.RawStylusInput.SetStylusPoints%2A> by calling the <xref:System.Windows.Input.StylusEventArgs.GetStylusPoints%2A> method.
## Examples
The following example demonstrates how to change the stylus points in the <xref:System.Windows.Input.StylusPlugIns.StylusPlugIn.OnStylusDown%2A> method. To create a <xref:System.Windows.Input.StylusPlugIns.StylusPlugIn> that restricts ink to a certain area, see the <xref:System.Windows.Input.StylusPlugIns.StylusPlugIn> overview.
:::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/StylusPlugIns/FilterPlugin.cs" id="Snippet8":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/StylusPluginSamples/VisualBasic/FilterPlugin.vb" id="Snippet8":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="StylusDeviceId">
<MemberSignature Language="C#" Value="public int StylusDeviceId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 StylusDeviceId" />
<MemberSignature Language="DocId" Value="P:System.Windows.Input.StylusPlugIns.RawStylusInput.StylusDeviceId" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property StylusDeviceId As Integer" />
<MemberSignature Language="F#" Value="member this.StylusDeviceId : int" Usage="System.Windows.Input.StylusPlugIns.RawStylusInput.StylusDeviceId" />
<MemberSignature Language="C++ CLI" Value="public:
 property int StylusDeviceId { int 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.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the identifier of the current stylus device.</summary>
<value>The identifier of the current <see cref="T:System.Windows.Input.StylusDevice" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following example ensures that the stylus points collected are from the same <xref:System.Windows.Input.StylusDevice>. This example is part of the bigger example in the <xref:System.Windows.Input.StylusPlugIns.RawStylusInput> class overview.
:::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/StylusPlugIns/RecognizerPlugin.cs" id="Snippet15":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/StylusPluginSamples/VisualBasic/RecognizerPlugin.vb" id="Snippet15":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="TabletDeviceId">
<MemberSignature Language="C#" Value="public int TabletDeviceId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 TabletDeviceId" />
<MemberSignature Language="DocId" Value="P:System.Windows.Input.StylusPlugIns.RawStylusInput.TabletDeviceId" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property TabletDeviceId As Integer" />
<MemberSignature Language="F#" Value="member this.TabletDeviceId : int" Usage="System.Windows.Input.StylusPlugIns.RawStylusInput.TabletDeviceId" />
<MemberSignature Language="C++ CLI" Value="public:
 property int TabletDeviceId { int 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.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the identifier of the current tablet device.</summary>
<value>The identifier of the current <see cref="T:System.Windows.Input.TabletDevice" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Timestamp">
<MemberSignature Language="C#" Value="public int Timestamp { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Timestamp" />
<MemberSignature Language="DocId" Value="P:System.Windows.Input.StylusPlugIns.RawStylusInput.Timestamp" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Timestamp As Integer" />
<MemberSignature Language="F#" Value="member this.Timestamp : int" Usage="System.Windows.Input.StylusPlugIns.RawStylusInput.Timestamp" />
<MemberSignature Language="C++ CLI" Value="public:
 property int Timestamp { int 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.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the time at which the input occurred.</summary>
<value>The time at which the input occurred.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The value of the <xref:System.Windows.Input.StylusPlugIns.RawStylusInput.Timestamp%2A> property is the value of the <xref:System.Environment.TickCount%2A?displayProperty=nameWithType> property at which the stylus event occurred.
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>