IUIX_CmdItemBox::InsertItem Method
From PDF XChange PDF SDK
(Automatic page editing by robot) |
|||
(10 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
+ | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IUIX_CmdItemBox::InsertItem Method}} | {{#customTitle:IUIX_CmdItemBox::InsertItem Method}} | ||
+ | {{#parentPage:PXV:IUIX_CmdItemBox#Methods|InsertItem|method}} | ||
− | + | {{ToReview}} | |
+ | |||
+ | Inserts new [[PXV:IUIX_CmdItem|command item]] in the command items box that is related to the given command. | ||
== Syntax == | == Syntax == | ||
− | <pre class="brush:cpp;gutter:false">HRESULT InsertItem([in] IUIX_Cmd* pCmd, [in, | + | <pre class="brush:cpp;gutter:false">HRESULT InsertItem([in] IUIX_Cmd* pCmd, |
+ | [in, defaultvalue(-1)] LONG nIndexBefore, | ||
+ | [in, defaultvalue(0)] LONG nNewStyle, | ||
+ | [in, defaultvalue(0)] LONG nNewStyleMask, | ||
+ | [out, retval, defaultvalue(NULL)] IUIX_CmdItem** pItem);</pre> | ||
== Parameters == | == Parameters == | ||
− | ; | + | ;pCmd |
− | :[in] Pointer to [[PXV:IUIX_Cmd|IUIX_Cmd]]. | + | :[in] Pointer to [[PXV:IUIX_Cmd|IUIX_Cmd]] containing the command that will be inserted. |
− | ; | + | ;nIndexBefore |
− | :[in, | + | :[in, defaultvalue(-1)] Value of LONG containing the command item insert index. |
− | ; | + | ;nNewStyle |
− | :[in, | + | :[in, defaultvalue(0)] Value of LONG containing the [[PXV:UIX_CmdItemStyleFlags|new command item's style]]. |
− | ; | + | ;nNewStyleMask |
− | :[in, | + | :[in, defaultvalue(0)] Value of LONG containing the style mask. |
− | ; | + | ;pItem |
− | :[out, retval, | + | :[out, retval, defaultvalue(NULL)] Pointer to [[PXV:IUIX_CmdItem|IUIX_CmdItem]] containing the newly inserted command item. |
== Return Value == | == Return Value == | ||
Line 23: | Line 31: | ||
== See Also == | == See Also == | ||
− | + | [[PXV:IUIX_CmdItemBox|IUIX_CmdItemBox]] |
Latest revision as of 07:15, 24 March 2016
Inserts new command item in the command items box that is related to the given command.
Syntax
HRESULT InsertItem([in] IUIX_Cmd* pCmd, [in, defaultvalue(-1)] LONG nIndexBefore, [in, defaultvalue(0)] LONG nNewStyle, [in, defaultvalue(0)] LONG nNewStyleMask, [out, retval, defaultvalue(NULL)] IUIX_CmdItem** pItem);
Parameters
- pCmd
- [in] Pointer to IUIX_Cmd containing the command that will be inserted.
- nIndexBefore
- [in, defaultvalue(-1)] Value of LONG containing the command item insert index.
- nNewStyle
- [in, defaultvalue(0)] Value of LONG containing the new command item's style.
- nNewStyleMask
- [in, defaultvalue(0)] Value of LONG containing the style mask.
- pItem
- [out, retval, defaultvalue(NULL)] Pointer to IUIX_CmdItem containing the newly inserted command item.
Return Value
Returns S_OK if operation was successful or error code in other cases.