forked from dotnet/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathKeyboard.xml
530 lines (440 loc) · 22.3 KB
/
Keyboard.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
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
<Type Name="Keyboard" FullName="Microsoft.VisualBasic.Devices.Keyboard">
<TypeSignature Language="C#" Value="public class Keyboard" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi Keyboard extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.VisualBasic.Devices.Keyboard" />
<AssemblyInfo>
<AssemblyName>Microsoft.VisualBasic</AssemblyName>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Provides properties for accessing the current state of the keyboard, such as what keys are currently pressed, and provides a method to send keystrokes to the active window.</summary>
<remarks>
<format type="text/markdown"><|
## Availability by Project Type
|Project type|Available|
|-|-|
|Windows Application|**Yes**|
|Class Library|**Yes**|
|Console Application|**Yes**|
|Windows Control Library|**Yes**|
|Web Control Library|No|
|Windows Service|**Yes**|
|Web Site|No|
## Examples
This example uses the `My.Computer.Keyboard.CtrlKeyDown` property to determine if the computer's CTRL key is pressed.
[!code-vb[VbVbalrMyComputer#36](~/samples/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbalrMyComputer/VB/Class2.vb#36)]
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Keyboard ();" />
<MemberSignature Language="ILAsm" Value=".method public specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.VisualBasic.Devices.Keyboard.#ctor" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.VisualBasic</AssemblyName>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:Microsoft.VisualBasic.Devices.Keyboard" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AltKeyDown">
<MemberSignature Language="C#" Value="public bool AltKeyDown { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool AltKeyDown" />
<MemberSignature Language="DocId" Value="P:Microsoft.VisualBasic.Devices.Keyboard.AltKeyDown" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.VisualBasic</AssemblyName>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a <see langword="Boolean" /> indicating if the ALT key is down.</summary>
<value>A <see langword="Boolean" /> value: <see langword="True" /> if the ALT key is down; otherwise <see langword="False" />.</value>
<remarks>
<format type="text/markdown"><]
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="CapsLock">
<MemberSignature Language="C#" Value="public bool CapsLock { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool CapsLock" />
<MemberSignature Language="DocId" Value="P:Microsoft.VisualBasic.Devices.Keyboard.CapsLock" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.VisualBasic</AssemblyName>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>get: System.Security.SecuritySafeCritical</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a <see langword="Boolean" /> indicating if CAPS LOCK is turned on.</summary>
<value>A <see langword="Boolean" /> value: <see langword="True" /> if CAPS LOCK is turned on; otherwise <see langword="False" />.</value>
<remarks>
<format type="text/markdown"><]
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="CtrlKeyDown">
<MemberSignature Language="C#" Value="public bool CtrlKeyDown { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool CtrlKeyDown" />
<MemberSignature Language="DocId" Value="P:Microsoft.VisualBasic.Devices.Keyboard.CtrlKeyDown" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.VisualBasic</AssemblyName>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a <see langword="Boolean" /> indicating if a CTRL key is down.</summary>
<value>A <see langword="Boolean" /> value. <see langword="True" /> if a CTRL key is down; otherwise <see langword="False" />.</value>
<remarks>
<format type="text/markdown"><]
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="NumLock">
<MemberSignature Language="C#" Value="public bool NumLock { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool NumLock" />
<MemberSignature Language="DocId" Value="P:Microsoft.VisualBasic.Devices.Keyboard.NumLock" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.VisualBasic</AssemblyName>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>get: System.Security.SecuritySafeCritical</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a <see langword="Boolean" /> indicating if the NUM LOCK key is on.</summary>
<value>A <see langword="Boolean" /> value. <see langword="True" /> if NUM LOCK is on; otherwise <see langword="False" />.</value>
<remarks>
<format type="text/markdown"><]
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ScrollLock">
<MemberSignature Language="C#" Value="public bool ScrollLock { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool ScrollLock" />
<MemberSignature Language="DocId" Value="P:Microsoft.VisualBasic.Devices.Keyboard.ScrollLock" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.VisualBasic</AssemblyName>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>get: System.Security.SecuritySafeCritical</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a <see langword="Boolean" /> indicating whether the SCROLL LOCK key is on.</summary>
<value>A <see langword="Boolean" /> value. <see langword="True" /> if SCROLL LOCK is on; otherwise <see langword="False" />.</value>
<remarks>
<format type="text/markdown"><]
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="SendKeys">
<MemberSignature Language="C#" Value="public void SendKeys (string keys);" />
<MemberSignature Language="ILAsm" Value=".method public instance void SendKeys(string keys) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.VisualBasic.Devices.Keyboard.SendKeys(System.String)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.VisualBasic</AssemblyName>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="keys" Type="System.String" />
</Parameters>
<Docs>
<param name="keys">A <see langword="String" /> that defines the keys to send.</param>
<summary>Sends one or more keystrokes to the active window, as if typed on the keyboard.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The `My.Computer.Keyboard.SendKeys` method provides functionality similar to the <xref:System.Windows.Forms.SendKeys.Send%2A> and <xref:System.Windows.Forms.SendKeys.SendWait%2A> methods.
The `wait` argument is useful if the other application must finish before your application can continue.
> [!NOTE]
> Because there is no managed method to activate another application, you can either use this class within the current application, manually select the window to send the keys to, or use Windows API methods, such as `FindWindow` and `SetForegroundWindow`, to force focus on other applications. For more information, see [Walkthrough: Calling Windows APIs](~/docs/visual-basic/programming-guide/com-interop/walkthrough-calling-windows-apis.md).
The `keys` argument can specify any single key or any key combined with ALT, CTRL, or SHIFT (or any combination of those keys). Each key is represented by one or more characters, such as `a` for the character "a", or `{ENTER}` for the ENTER key.
To combine a key with SHIFT, precede the key code with `+` (plus sign). To combine a key with CTRL, precede the key code with `^` (caret). To combine a key with ALT, precede the key code with `%` (percent sign). To specify repeating keys, use the form `{`*key number*`}`. You must put a space between *key* and *number*. For example, `{LEFT 42}` means "press the LEFT ARROW key 42 times"; `{h 10}` means "press 'h' 10 times."
The following table lists the codes that can be used to specify characters that are not displayed when you press the corresponding key (such as ENTER or TAB).
|Key|Code|
|-|-|
|BACKSPACE|{BACKSPACE} or {BS}|
|BREAK|{BREAK}|
|CAPS LOCK|{CAPSLOCK}|
|CLEAR|{CLEAR}|
|DELETE|{DELETE} or {DEL}|
|DOWN ARROW|{DOWN}|
|END|{END}|
|ENTER (numeric keypad)|{ENTER}|
|ENTER|~|
|ESC|{ESCAPE} or {ESC}|
|HELP|{HELP}|
|HOME|{HOME}|
|INS|{INSERT}|
|LEFT ARROW|{LEFT}|
|NUM LOCK|{NUMLOCK}|
|PAGE DOWN|{PGDN}|
|PAGE UP|{PGUP}|
|RETURN|{RETURN}|
|RIGHT ARROW|{RIGHT}|
|SCROLL LOCK|{SCROLLLOCK}|
|TAB|{TAB}|
|UP ARROW|{UP}|
|F1 through F15|{F1} through {F15}|
## Availability by Project Type
|Project type|Available|
|-|-|
|Windows Application|**Yes**|
|Class Library|**Yes**|
|Console Application|**Yes**|
|Windows Control Library|**Yes**|
|Web Control Library|No|
|Windows Service|**Yes**|
|Web Site|No|
## Examples
This example uses the `My.Computer.Keyboard.SendKeys` method to send keystrokes to an external application, the Calculator application, started by the `Shell` function.
[!code-vb[VbVbalrMyComputer#25](~/samples/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbalrMyComputer/VB/Class2.vb#25)]
A <xref:System.ArgumentException> exception is raised if an application with the requested process identifier cannot be found.
The call to the `Shell` function requires full trust (<xref:System.Security.SecurityException> class).
]]></format>
</remarks>
<exception cref="T:System.Security.SecurityException">A partial-trust situation exists in which the user lacks necessary permissions.</exception>
<permission cref="T:System.Security.Permissions.FileIOPermission">Controls the ability to access files and folders. Associated enumeration: <see cref="F:System.Security.Permissions.PermissionState.Unrestricted" />.</permission>
<permission cref="T:System.Security.Permissions.UIPermission">Controls the permissions related to user interfaces and the clipboard. Associated enumeration: <see cref="F:System.Security.Permissions.UIPermissionWindow.AllWindows" />.</permission>
</Docs>
</Member>
<Member MemberName="SendKeys">
<MemberSignature Language="C#" Value="public void SendKeys (string keys, bool wait);" />
<MemberSignature Language="ILAsm" Value=".method public instance void SendKeys(string keys, bool wait) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.VisualBasic.Devices.Keyboard.SendKeys(System.String,System.Boolean)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.VisualBasic</AssemblyName>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="keys" Type="System.String" />
<Parameter Name="wait" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="keys">A <see langword="String" /> that defines the keys to send.</param>
<param name="wait">Optional. A <see langword="Boolean" /> that specifies whether or not to wait for keystrokes to get processed before the application continues. <see langword="True" /> by default.</param>
<summary>Sends one or more keystrokes to the active window, as if typed on the keyboard.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The `My.Computer.Keyboard.SendKeys` method provides functionality similar to the <xref:System.Windows.Forms.SendKeys.Send%2A> and <xref:System.Windows.Forms.SendKeys.SendWait%2A> methods.
The `wait` argument is useful if the other application must finish before your application can continue.
> [!NOTE]
> Because there is no managed method to activate another application, you can either use this class within the current application, manually select the window to send the keys to, or use Windows API methods, such as `FindWindow` and `SetForegroundWindow`, to force focus on other applications. For more information, see [Walkthrough: Calling Windows APIs](~/docs/visual-basic/programming-guide/com-interop/walkthrough-calling-windows-apis.md).
The `keys` argument can specify any single key or any key combined with ALT, CTRL, or SHIFT (or any combination of those keys). Each key is represented by one or more characters, such as `a` for the character "a", or `{ENTER}` for the ENTER key.
To combine a key with SHIFT, precede the key code with `+` (plus sign). To combine a key with CTRL, precede the key code with `^` (caret). To combine a key with ALT, precede the key code with `%` (percent sign). To specify repeating keys, use the form `{`*key number*`}`. You must put a space between *key* and *number*. For example, `{LEFT 42}` means "press the LEFT ARROW key 42 times"; `{h 10}` means "press 'h' 10 times."
The following table lists the codes that can be used to specify characters that are not displayed when you press the corresponding key (such as ENTER or TAB).
|Key|Code|
|-|-|
|BACKSPACE|{BACKSPACE} or {BS}|
|BREAK|{BREAK}|
|CAPS LOCK|{CAPSLOCK}|
|CLEAR|{CLEAR}|
|DELETE|{DELETE} or {DEL}|
|DOWN ARROW|{DOWN}|
|END|{END}|
|ENTER (numeric keypad)|{ENTER}|
|ENTER|~|
|ESC|{ESCAPE} or {ESC}|
|HELP|{HELP}|
|HOME|{HOME}|
|INS|{INSERT}|
|LEFT ARROW|{LEFT}|
|NUM LOCK|{NUMLOCK}|
|PAGE DOWN|{PGDN}|
|PAGE UP|{PGUP}|
|RETURN|{RETURN}|
|RIGHT ARROW|{RIGHT}|
|SCROLL LOCK|{SCROLLLOCK}|
|TAB|{TAB}|
|UP ARROW|{UP}|
|F1 through F15|{F1} through {F15}|
## Availability by Project Type
|Project type|Available|
|-|-|
|Windows Application|**Yes**|
|Class Library|**Yes**|
|Console Application|**Yes**|
|Windows Control Library|**Yes**|
|Web Control Library|No|
|Windows Service|**Yes**|
|Web Site|No|
## Examples
This example uses the `My.Computer.Keyboard.SendKeys` method to send keystrokes to an external application, the Calculator application, started by the `Shell` function.
[!code-vb[VbVbalrMyComputer#25](~/samples/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbalrMyComputer/VB/Class2.vb#25)]
A <xref:System.ArgumentException> exception is raised if an application with the requested process identifier cannot be found.
The call to the `Shell` function requires full trust (<xref:System.Security.SecurityException> class).
]]></format>
</remarks>
<exception cref="T:System.Security.SecurityException">A partial-trust situation exists in which the user lacks necessary permissions.</exception>
<permission cref="T:System.Security.Permissions.FileIOPermission">Controls the ability to access files and folders. Associated enumeration: <see cref="F:System.Security.Permissions.PermissionState.Unrestricted" />.</permission>
<permission cref="T:System.Security.Permissions.UIPermission">Controls the permissions related to user interfaces and the clipboard. Associated enumeration: <see cref="F:System.Security.Permissions.UIPermissionWindow.AllWindows" />.</permission>
</Docs>
</Member>
<Member MemberName="ShiftKeyDown">
<MemberSignature Language="C#" Value="public bool ShiftKeyDown { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool ShiftKeyDown" />
<MemberSignature Language="DocId" Value="P:Microsoft.VisualBasic.Devices.Keyboard.ShiftKeyDown" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.VisualBasic</AssemblyName>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a <see langword="Boolean" /> indicating if a SHIFT key is down.</summary>
<value>A <see langword="Boolean" /> value. <see langword="True" /> if a SHIFT key is down; otherwise <see langword="False" />.</value>
<remarks>
<format type="text/markdown"><]
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>