 | Keyboard Class |
Provides keyboard actions and events.
Inheritance HierarchySystemObject
RanorexKeyboard
RanorexKeyboard
Namespace: Ranorex
Assembly: Ranorex.Core (in Ranorex.Core.dll) Version: 12.7.4-git.38314c06
SyntaxThe Keyboard type exposes the following members.
ConstructorsProperties| Name | Description | |
|---|---|---|
  | AbortKey |
Gets or sets a key-modifier combination that aborts the current thread if pressed.
|
| CharacterMappingEnabled |
Gets or sets a value whether Unicode characters are tried to be mapped to
virtual keyboard inputs.
|
| DefaultKeyPressTime | |
| Enabled |
Gets or sets a value indicating whether physical keyboard actions are enabled.
|
| PauseKey |
Gets or sets a key-modifier combination that pauses or resumes the current test execution if pressed.
|
Methods| Name | Description | |
|---|---|---|
 | Down(Char) |
Sets the state of the key associated with the specified character to pressed/down.
|
| Down(Keys) |
Sets the state of the specified key to pressed/down.
|
| Down(Char, Boolean) |
Sets the state of the key associated with the specified character to pressed/down.
|
| Down(Keys, Int32, Boolean) |
Sets the state of the specified key to pressed/down.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| EscapeSequence |
Replaces escape characters in sequence by their
escaped representation to be used with the Press(String) method.
|
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetSequenceFromKeyEvents(IListKeyValuePairKeyEventArgs, Boolean) |
Gets a string that can be passed to Press(String) from a list of key events.
|
| GetSequenceFromKeyEvents(IListKeyValuePairKeyEventArgs, Boolean, Int32) |
Gets a string that can be passed to Press(String) from a list of key events.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| PrepareFocus |
Tries to set the focus to the specified element if necessary and also tries
to make the element visible (if EnsureVisible is specified).
|
| Press(Char) |
Presses the key associated with the specified character and releases it again.
|
| Press(String) |
Presses the keys specified by sequence.
|
| Press(Keys) |
Presses the specified key and releases it again.
|
| Press(Char, Duration) |
Presses the key associated with the specified character and releases it again
after the specified time.
|
| Press(Char, Boolean) |
Presses the key associated with the specified character and releases it again.
|
| Press(String, Duration) |
Presses the keys specified by sequence.
|
| Press(Keys, Duration) |
Presses the specified key and releases it again after the specified time.
|
| Press(Element, String) |
Presses the keys specified by sequence.
|
| Press(Char, Duration, Boolean) |
Presses the key associated with the specified character and releases it again
after the specified time.
|
| Press(Char, Duration, Int32) |
Presses and releases the key associated with the specified character
for the specified number of times.
|
| Press(Keys, Duration, Int32) |
Presses and releases the specified key for the specified number of times.
|
| Press(Element, String, Duration) |
Presses the keys specified by sequence.
|
| Press(Char, Duration, Int32, Boolean) |
Presses and releases the key associated with the specified character
for the specified number of times.
|
| Press(Keys, Int32, Duration, Int32, Boolean) |
Presses and releases the specified key for the specified number of times.
|
| Set(Char, Boolean) |
Sets the state of the key associated with the specified character to either
pressed/down or released/up.
|
| Set(Keys, Boolean) |
Sets the state of the specified key to either pressed/down or released/up.
|
| Set(Char, Boolean, Boolean) |
Sets the state of the key associated with the specified character to either
pressed/down or released/up.
|
| Set(Keys, Int32, Boolean, Boolean) |
Sets the state of the specified key to either pressed/down or released/up.
|
| ToKey |
Converts the specified string representation (see ToString(Keys))
to a Keys value.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| ToString(Keys) |
Returns a string representation of the specified key.
|
| Up(Char) |
Sets the state of the key associated with the specified character to released/up.
|
| Up(Keys) |
Sets the state of the specified key to released/up.
|
| Up(Char, Boolean) |
Sets the state of the key associated with the specified character to released/up.
|
| Up(Keys, Int32, Boolean) |
Sets the state of the specified key to released/up.
|
Events| Name | Description | |
|---|---|---|
 | KeyDown |
Occurs when a key is pressed or hold down.
|
| KeyUp |
Occurs when a key is released.
|
Fields| Name | Description | |
|---|---|---|
 | DefaultScanCode |
Specify this value if you want to use the default hardware scan code corresponding
to a specified virtual key code (see Keys).
|
See Also