IUIX_CmdBar::InsertItem Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IUIX_CmdBar::InsertItem Method}} | {{#customTitle:IUIX_CmdBar::InsertItem Method}} | ||
| − | {{#parentPage:PXV:IUIX_CmdBar|InsertItem | + | {{#parentPage:PXV:IUIX_CmdBar#Methods|InsertItem|method}} |
| − | + | ||
{{ToReview}} | {{ToReview}} | ||
| − | + | Inserts command into the given [[PXV:IUIX_CmdItemBox|command box]]. | |
== Syntax == | == Syntax == | ||
| Line 14: | Line 13: | ||
[in, defaultvalue(0)] LONG nNewStyleMask, | [in, defaultvalue(0)] LONG nNewStyleMask, | ||
[in, defaultvalue(0)] LONG nBoxIndex, | [in, defaultvalue(0)] LONG nBoxIndex, | ||
| − | [out, retval, defaultvalue(NULL)] IUIX_CmdItem** | + | [out, retval, defaultvalue(NULL)] IUIX_CmdItem** pItem);</pre> |
== Parameters == | == Parameters == | ||
;pCmd | ;pCmd | ||
| − | :[in] Pointer to [[PXV:IUIX_Cmd|IUIX_Cmd]]. | + | :[in] Pointer to [[PXV:IUIX_Cmd|IUIX_Cmd]] containing the command that will be inserted into the command box. |
;nIndexBefore | ;nIndexBefore | ||
| − | :[in, defaultvalue(-1)] Value of LONG. | + | :[in, defaultvalue(-1)] Value of LONG containing the insert index. |
;nNewStyle | ;nNewStyle | ||
| − | :[in, defaultvalue(0)] Value of LONG. | + | :[in, defaultvalue(0)] Value of LONG containing the [[PXV:UIX_CmdItemStyleFlags|new command item's style]]. |
;nNewStyleMask | ;nNewStyleMask | ||
| − | :[in, defaultvalue(0)] Value of LONG. | + | :[in, defaultvalue(0)] Value of LONG containing the style mask. |
;nBoxIndex | ;nBoxIndex | ||
| − | :[in, defaultvalue(0)] Value of LONG. | + | :[in, defaultvalue(0)] Value of LONG containing the command items box index. |
| − | ; | + | ;pItem |
| − | :[out, retval, defaultvalue(NULL)] Pointer to [[PXV:IUIX_CmdItem|IUIX_CmdItem]]. | + | :[out, retval, defaultvalue(NULL)] Pointer to [[PXV:IUIX_CmdItem|IUIX_CmdItem]] containing the newly inserted command item. |
== Return Value == | == Return Value == | ||
| Line 34: | Line 33: | ||
== See Also == | == See Also == | ||
| − | [[PXV:IUIX_CmdBar|IUIX_CmdBar]] | + | [[PXV:IUIX_CmdBar|IUIX_CmdBar]] |
Latest revision as of 05:39, 25 March 2016
Inserts command into the given command box.
Syntax
HRESULT InsertItem([in] IUIX_Cmd* pCmd,
[in, defaultvalue(-1)] LONG nIndexBefore,
[in, defaultvalue(0)] LONG nNewStyle,
[in, defaultvalue(0)] LONG nNewStyleMask,
[in, defaultvalue(0)] LONG nBoxIndex,
[out, retval, defaultvalue(NULL)] IUIX_CmdItem** pItem);
Parameters
- pCmd
- [in] Pointer to IUIX_Cmd containing the command that will be inserted into the command box.
- nIndexBefore
- [in, defaultvalue(-1)] Value of LONG containing the 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.
- nBoxIndex
- [in, defaultvalue(0)] Value of LONG containing the command items box index.
- 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.
