diff --git a/PhoenixAPI/AddShortcut.md b/PhoenixAPI/AddShortcut.md index d064f47..7712b7c 100644 --- a/PhoenixAPI/AddShortcut.md +++ b/PhoenixAPI/AddShortcut.md @@ -29,7 +29,7 @@ Arguments marked as _(Optional)_ must be specified if there are succeeding argum || `Normal` - Start the program normally. | || `Minimized` - Start the program minimized to the taskbar. | || `Maximized` - Start the program maximized. | -| Hotkey | (Optional) Keyboard sequence used to active the shortcut. `Ctrl + Alt `| +| Hotkey | (Optional) Keyboard sequence (ex. Ctrl + Alt + L) used to active the shortcut. (See Remarks)| | Tooltip | (Optional) Tooltip Text. | ## Return Codes @@ -38,7 +38,53 @@ None. ## Remarks -None. +### Hotkey format + +Hotkeys for windows shortcuts are of the following form: `Ctrl+Alt+X`, `Ctrl+Shift+X`, `Shift+Alt+X`, `Ctrl+NumPadKey`, or `Alt+NumPadKey` where `X` represents a letter, number, punctuation, or function key. If you specify an invalid form, Windows typically defaults to `Ctrl+Alt` + +Note that Windows distinguishes number pad keys from regular number and punctuation keys. You should try and avoid assignments that may conflict with standard application hotkeys. + +Windows prohibits ESC, ENTER, TAB, SPACEBAR, PRINT SCREEN, SHIFT, or BACKSPACE from being used in hotkeys. + + +| Command | Resulting Key | +| --- | --- | +| `^` | The CTRL keystroke, therefore `^!a` would set the hotkey to `Ctrl+Alt+A`. Note that CTRL is case sensitive, `^A` is not the same as `^a`. | +| `!` | An ALT keystroke, therefore `!a` would set the hotkey to `Alt+a`. Note that ALT is case sensitive, `!A` is not the same as `!a`. | +| `+` | The SHIFT keystroke, therefore `!+a` would set the hotkey to `Alt+Shift+a`. | +| `#` | The Windows keystroke, therefore `#r` would set the hotkey to `Win+R`. | +| `{!}` | ! | +| `{#}` | # | +| `{+}` | + | +| `{^}` | ^ | +| `{{}` | { | +| `{}}` | } | +| `{ALT}` | ALT | +| `{DELETE}` or `{DEL}` | DELETE | +| `{UP}` | Up arrow. | +| `{DOWN}` | Down arrow. | +| `{LEFT}` | Left arrow. | +| `{RIGHT}` | Right arrow. | +| `{HOME}` | HOME | +| `{END}` | END | +| `{INSERT}` or `{INS}` | INSERT | +| `{PGUP}` | PageUp | +| `{PGDN}` | PageDown | +| `{F1}` - `{F12}` | Function keys. | +| `{LWIN}` | Left Windows key. | +| `{RWIN}` | Right Windows key. | +| `{PAUSE}` | PAUSE | +| `{NUMPAD0}` - `{NUMPAD9}` | Numpad digits. | +| `{NUMPADMULT}` | Numpad Multiply. | +| `{NUMPADADD}` | Numpad Add. | +| `{NUMPADSUB}` | Numpad Subtract. | +| `{NUMPADDIV}` | Numpad Divide. | +| `{NUMPADDOT}` | Numpad period. | +| `{APPSKEY}` | Windows App key. | +| `{LALT}` | Left ALT key. | +| `{RALT}` | Right ALT key. | +| `{LCTRL}` | Left CTRL key. | +| `{RCTRL}` | Right CTRL key. | ## Related @@ -82,6 +128,6 @@ Advanced start menu example, all parameters. ```pebakery -AddShortcut,StartMenu,"System","ImDisk Control Panel","#$pWinDir#$p\System32\imdisk.cpl","","#$pWinDir#$p","%WinDir%\System32\imdisk.cpl",-1,Minimized,"Ctrl + Alt + I","Configure Imdisk" +AddShortcut,StartMenu,"System","ImDisk Control Panel","#$pWinDir#$p\System32\imdisk.cpl","","#$pWinDir#$p","%WinDir%\System32\imdisk.cpl",-1,Minimized,"^!i","Configure Imdisk" ``` \ No newline at end of file