IUIX_CmdMenu::InsertItem4 Method
From PDF XChange PDF SDK
(Automatic page editing by robot) |
|||
(8 intermediate revisions by one other user not shown) | |||
Line 1: | Line 1: | ||
+ | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IUIX_CmdMenu::InsertItem4 Method}} | {{#customTitle:IUIX_CmdMenu::InsertItem4 Method}} | ||
+ | {{#parentPage:PXV:IUIX_CmdMenu#Methods|InsertItem4|method}} | ||
+ | {{ToReview}} | ||
− | + | Inserts new command menu item with given item ID, data, and style. | |
== Syntax == | == Syntax == | ||
− | <pre class="brush:cpp;gutter:false">HRESULT InsertItem4([in] BSTR | + | <pre class="brush:cpp;gutter:false">HRESULT InsertItem4([in] BSTR sItemID, |
+ | [in] BSTR sText, | ||
+ | [in, defaultvalue(0)] LONG nState, | ||
+ | [in, defaultvalue(NULL)] IUIX_Icon* pIcon, | ||
+ | [in, defaultvalue("")] BSTR sTip, | ||
+ | [in, defaultvalue(-1)] LONG nIndexBefore, | ||
+ | [in, defaultvalue(0)] LONG nStyle, | ||
+ | [out, retval, defaultvalue(NULL)] IUIX_CmdMenu** pItem);</pre> | ||
== Parameters == | == Parameters == | ||
− | ; | + | ;sItemID |
− | :[in] Value of BSTR. | + | :[in] Value of BSTR containing the command item ID. |
− | ; | + | ;sText |
− | :[in] Value of BSTR. | + | :[in] Value of BSTR containing the text that will be displayed as a command menu item's label. |
− | ; | + | ;nState |
− | :[in, | + | :[in, defaultvalue(0)] Value of LONG containing the [[PXV:UIX_CmdItemState|command item's state]]. |
− | ; | + | ;pIcon |
− | :[in, | + | :[in, defaultvalue(NULL)] Pointer to [[PXV:IUIX_Icon|IUIX_Icon]] containing the command's icon. |
− | ; | + | ;sTip |
− | :[in, | + | :[in, defaultvalue("")] Value of BSTR containing the command's tooltip. |
− | ; | + | ;nIndexBefore |
− | :[in, | + | :[in, defaultvalue(-1)] Value of LONG containing the command insertion index. |
− | ; | + | ;nStyle |
− | :[in, | + | :[in, defaultvalue(0)] Value of LONG containing the [[PXV:UIX_CmdItemStyleFlags|command style flags]]. |
− | ; | + | ;pItem |
− | :[out, retval, | + | :[out, retval, defaultvalue(NULL)] Pointer to [[PXV:IUIX_CmdMenu|IUIX_CmdMenu]] containing the resulting command menu item. |
== Return Value == | == Return Value == | ||
Line 29: | Line 39: | ||
== See Also == | == See Also == | ||
− | + | [[PXV:IUIX_CmdMenu|IUIX_CmdMenu]] |
Latest revision as of 06:39, 1 April 2016
Inserts new command menu item with given item ID, data, and style.
Syntax
HRESULT InsertItem4([in] BSTR sItemID, [in] BSTR sText, [in, defaultvalue(0)] LONG nState, [in, defaultvalue(NULL)] IUIX_Icon* pIcon, [in, defaultvalue("")] BSTR sTip, [in, defaultvalue(-1)] LONG nIndexBefore, [in, defaultvalue(0)] LONG nStyle, [out, retval, defaultvalue(NULL)] IUIX_CmdMenu** pItem);
Parameters
- sItemID
- [in] Value of BSTR containing the command item ID.
- sText
- [in] Value of BSTR containing the text that will be displayed as a command menu item's label.
- nState
- [in, defaultvalue(0)] Value of LONG containing the command item's state.
- pIcon
- [in, defaultvalue(NULL)] Pointer to IUIX_Icon containing the command's icon.
- sTip
- [in, defaultvalue("")] Value of BSTR containing the command's tooltip.
- nIndexBefore
- [in, defaultvalue(-1)] Value of LONG containing the command insertion index.
- nStyle
- [in, defaultvalue(0)] Value of LONG containing the command style flags.
- pItem
- [out, retval, defaultvalue(NULL)] Pointer to IUIX_CmdMenu containing the resulting command menu item.
Return Value
Returns S_OK if operation was successful or error code in other cases.