IUIX_CmdBar::FlatInsertItem Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| (8 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IUIX_CmdBar::FlatInsertItem Method}} | {{#customTitle:IUIX_CmdBar::FlatInsertItem Method}} | ||
| + | {{#parentPage:PXV:IUIX_CmdBar#Methods|FlatInsertItem|method}} | ||
| + | {{ToReview}} | ||
| − | + | Inserts command in the command bar's command item box by given [[PXV:IUIX_CmdItem_FlatIndex|FlatIndex]]. | |
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">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** | + | <pre class="brush:cpp;gutter:false">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);</pre> | ||
== Parameters == | == Parameters == | ||
| − | ; | + | ;pCmd |
| − | :[in] Pointer to [[PXV:IUIX_Cmd|IUIX_Cmd]]. | + | :[in] Pointer to [[PXV:IUIX_Cmd|IUIX_Cmd]] containing the command that should be inserted. |
| − | ; | + | ;nFlatIndexBefore |
| − | :[in, defaultvalue(-1)] Value of LONG. | + | :[in, defaultvalue(-1)] Value of LONG containing the [[PXV:IUIX_CmdItem_FlatIndex|FlatIndex]] before which the command would be inserted. |
| − | ; | + | ;nNewStyle |
| − | :[in, defaultvalue(0)] Value of LONG. | + | :[in, defaultvalue(0)] Value of LONG containing the [[PXV:UIX_CmdItemStyleFlags|command item's style]]. |
| − | ; | + | ;nNewStyleMask |
| − | :[in, defaultvalue(0)] Value of LONG. | + | :[in, defaultvalue(0)] Value of LONG containing the style mask. |
| − | ; | + | ;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 23: | Line 30: | ||
== See Also == | == See Also == | ||
| − | + | [[PXV:IUIX_CmdBar|IUIX_CmdBar]] | |
Latest revision as of 03: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.
