IUIX_CmdBar::FlatInsertItem Method
From PDF XChange PDF SDK
| Line 5: | Line 5: | ||
{{ToReview}} | {{ToReview}} | ||
| − | + | Inserts command in the command bar's command item box by given [[PXV:IUIX_CmdItem_FlatIndex|FlatIndex]]. | |
== Syntax == | == Syntax == | ||
| Line 20: | Line 20: | ||
:[in, defaultvalue(-1)] Value of LONG containing the [[PXV:IUIX_CmdItem_FlatIndex|FlatIndex]] before which the command would be inserted. | :[in, defaultvalue(-1)] Value of LONG containing the [[PXV:IUIX_CmdItem_FlatIndex|FlatIndex]] before which the command would be inserted. | ||
;nNewStyle | ;nNewStyle | ||
| − | :[in, defaultvalue(0)] Value of LONG containing the [[PXV: | + | :[in, defaultvalue(0)] Value of LONG containing the [[PXV:UIX_CmdItemStyleFlags|command item's style]]. |
;nNewStyleMask | ;nNewStyleMask | ||
:[in, defaultvalue(0)] Value of LONG containing the style mask. | :[in, defaultvalue(0)] Value of LONG containing the style mask. | ||
Latest revision as of 02:52, 25 March 2016
Inserts command in the command bar's command item box by given FlatIndex.
Syntax
HRESULT FlatInsertItem([in] IUIX_Cmd* pCmd,
[in, defaultvalue(-1)] LONG nFlatIndexBefore,
[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 should be inserted.
- nFlatIndexBefore
- [in, defaultvalue(-1)] Value of LONG containing the FlatIndex before which the command would be inserted.
- nNewStyle
- [in, defaultvalue(0)] Value of LONG containing the 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.
