key
Sample Usage
-Kind Regards{key:shift-tab}{key:enter}
Attributes
| Attribute Name | Type | Description |
|---|---|---|
| Positional | text | The key press to simulate. |
| trim | yes/no/left/right | If yes whitespace is removed before and after the command. If left, only whitespace to the left is removed. If right, only whitespace to the right is removed. |
The key is specified in the form modifiers-character where character is the key which is pressed (e.g. s or a non-character like tab) and the optional modifiers are keys like the shift key or the ctrl key.
Non-Character Keys
In addition to key presses that can be represented with a standard keyboard character (e.g. ctrl-s or ctrl-p), the following non-character keys are supported:
| Key | Key Token |
|---|---|
| Tab Key | tab |
| Enter Key | enter |
| Backspace Key | backspace |
| Left Arrow Key | leftarrow |
| Right Arrow Key | rightarrow |
An example of usage of these keys would be {key:tab} to tab to the next field in the webpage (or {key:shift-tab} to tab to the prior field in the document). The remainder of the snippet would then be entered in that field allowing you to fill out multiple fields with a single snippet.
The enter key is also useful for pressing buttons in order to submit a form or trigger some action. tab and enter key commands can often be used sequentially to enable a variety of scripting behaviors.
To learn more about scripting pages, see the autopilot guide.
Modifiers
The following modifiers are supported:
| Key | Modifier |
|---|---|
| Shift Key | shift |
| Control Key | ctrl |
| Alt (Option) Key | alt |
| Command (Meta) Key | cmd |
Modifiers may be joined together with hyphens. For example ctrl-shift-x or alt-shift-tab.