IUIX_CmdMenu::InsertItem2 Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| (3 intermediate revisions by one other user not shown) | |||
| Line 2: | Line 2: | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IUIX_CmdMenu::InsertItem2 Method}} | {{#customTitle:IUIX_CmdMenu::InsertItem2 Method}} | ||
| − | {{#parentPage:PXV:IUIX_CmdMenu#Methods|InsertItem2 | + | {{#parentPage:PXV:IUIX_CmdMenu#Methods|InsertItem2|method}} |
| − | + | ||
{{ToReview}} | {{ToReview}} | ||
| − | + | Inserts command in the command menu with given style flags. | |
== Syntax == | == Syntax == | ||
| Line 14: | Line 13: | ||
[in, defaultvalue(0)] LONG nNewStyleMask, | [in, defaultvalue(0)] LONG nNewStyleMask, | ||
[in, defaultvalue(NULL)] IUIX_CmdHandler* pCustomHandler, | [in, defaultvalue(NULL)] IUIX_CmdHandler* pCustomHandler, | ||
| − | [out, retval, defaultvalue(NULL)] IUIX_CmdMenu** | + | [out, retval, defaultvalue(NULL)] IUIX_CmdMenu** pItem);</pre> |
== Parameters == | == Parameters == | ||
;nCmdID | ;nCmdID | ||
| − | :[in] Value of LONG. | + | :[in] Value of LONG containing the command ID that needs to be inserted. |
;nIndexBefore | ;nIndexBefore | ||
| − | :[in, defaultvalue(-1)] Value of LONG. | + | :[in, defaultvalue(-1)] Value of LONG containing the command insertion index. |
;nNewStyle | ;nNewStyle | ||
| − | :[in, defaultvalue(0)] Value of LONG. | + | :[in, defaultvalue(0)] Value of LONG containing the [[PXV:UIX_CmdItemStyleFlags|command style flags]]. |
;nNewStyleMask | ;nNewStyleMask | ||
| − | :[in, defaultvalue(0)] Value of LONG. | + | :[in, defaultvalue(0)] Value of LONG containing the command style mask. |
;pCustomHandler | ;pCustomHandler | ||
| − | :[in, defaultvalue(NULL)] Pointer to [[PXV:IUIX_CmdHandler|IUIX_CmdHandler]]. | + | :[in, defaultvalue(NULL)] Pointer to [[PXV:IUIX_CmdHandler|IUIX_CmdHandler]] containing the custom command handler (if needed). |
| − | ; | + | ;pItem |
| − | :[out, retval, defaultvalue(NULL)] Pointer to [[PXV:IUIX_CmdMenu|IUIX_CmdMenu]]. | + | :[out, retval, defaultvalue(NULL)] Pointer to [[PXV:IUIX_CmdMenu|IUIX_CmdMenu]] containing the resulting command menu item. |
== Return Value == | == Return Value == | ||
| Line 34: | Line 33: | ||
== See Also == | == See Also == | ||
| − | [[PXV:IUIX_CmdMenu|IUIX_CmdMenu]] | + | [[PXV:IUIX_CmdMenu|IUIX_CmdMenu]] |
Latest revision as of 06:32, 1 April 2016
Inserts command in the command menu with given style flags.
Syntax
HRESULT InsertItem2([in] LONG nCmdID,
[in, defaultvalue(-1)] LONG nIndexBefore,
[in, defaultvalue(0)] LONG nNewStyle,
[in, defaultvalue(0)] LONG nNewStyleMask,
[in, defaultvalue(NULL)] IUIX_CmdHandler* pCustomHandler,
[out, retval, defaultvalue(NULL)] IUIX_CmdMenu** pItem);
Parameters
- nCmdID
- [in] Value of LONG containing the command ID that needs to be inserted.
- nIndexBefore
- [in, defaultvalue(-1)] Value of LONG containing the command insertion index.
- nNewStyle
- [in, defaultvalue(0)] Value of LONG containing the command style flags.
- nNewStyleMask
- [in, defaultvalue(0)] Value of LONG containing the command style mask.
- pCustomHandler
- [in, defaultvalue(NULL)] Pointer to IUIX_CmdHandler containing the custom command handler (if needed).
- pItem
- [out, retval, defaultvalue(NULL)] Pointer to IUIX_CmdMenu containing the resulting command menu item.
Return Value
Returns S_OK if operation was successful or error code in other cases.
