IUIX_Cmd::AddShortcut Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IUIX_Cmd::AddShortcut Method}} | {{#customTitle:IUIX_Cmd::AddShortcut Method}} | ||
| − | {{#parentPage:PXV:IUIX_Cmd#Methods|AddShortcut | + | {{#parentPage:PXV:IUIX_Cmd#Methods|AddShortcut|method}} |
| − | + | ||
{{ToReview}} | {{ToReview}} | ||
| − | + | Adds new single shortcut to the command's shortcuts list. If the current combination is already inside the commands list with the same priority then it will be replaced. | |
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT AddShortcut([in] UIX_CmdAccel* | + | <pre class="brush:cpp;gutter:false">HRESULT AddShortcut([in] UIX_CmdAccel* stA, |
[in, defaultvalue(-1)] LONG nPriority);</pre> | [in, defaultvalue(-1)] LONG nPriority);</pre> | ||
== Parameters == | == Parameters == | ||
| − | ; | + | ;stA |
| − | :[in] Pointer to [[PXV:UIX_CmdAccel|UIX_CmdAccel]]. | + | :[in] Pointer to [[PXV:UIX_CmdAccel|UIX_CmdAccel]] containing the key combination. |
;nPriority | ;nPriority | ||
| − | :[in, defaultvalue(-1)] Value of LONG. | + | :[in, defaultvalue(-1)] Value of LONG containing the command's priority that acts as the index in the shortcuts list. |
== Return Value == | == Return Value == | ||
Latest revision as of 00:39, 24 March 2016
Adds new single shortcut to the command's shortcuts list. If the current combination is already inside the commands list with the same priority then it will be replaced.
Syntax
HRESULT AddShortcut([in] UIX_CmdAccel* stA,
[in, defaultvalue(-1)] LONG nPriority);
Parameters
- stA
- [in] Pointer to UIX_CmdAccel containing the key combination.
- nPriority
- [in, defaultvalue(-1)] Value of LONG containing the command's priority that acts as the index in the shortcuts list.
Return Value
Returns S_OK if operation was successful or error code in other cases.
