IUIX_CmdBar::InsertItem2 Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| Line 3: | Line 3: | ||
{{#customTitle:IUIX_CmdBar::InsertItem2 Method}} | {{#customTitle:IUIX_CmdBar::InsertItem2 Method}} | ||
{{#parentPage:PXV:IUIX_CmdBar#Methods|InsertItem2|method}} | {{#parentPage:PXV:IUIX_CmdBar#Methods|InsertItem2|method}} | ||
| − | |||
{{ToReview}} | {{ToReview}} | ||
| − | + | Insert command by it's ID into the given [[PXV:IUIX_CmdItemBox|command box]]. | |
== Syntax == | == Syntax == | ||
| Line 18: | Line 17: | ||
== Parameters == | == Parameters == | ||
;nCmdID | ;nCmdID | ||
| − | :[in] Value of LONG. | + | :[in] Value of LONG containing the command's ID of 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 | ;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 == | ||
Latest revision as of 05:40, 25 March 2016
Insert command by it's ID into the given command box.
Syntax
HRESULT InsertItem2([in] LONG nCmdID,
[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
- nCmdID
- [in] Value of LONG containing the command's ID of 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.
