IUIX_CmdMenu::InsertItem4 Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(One intermediate revision by one other user not shown)
Line 3: Line 3:
 
{{#customTitle:IUIX_CmdMenu::InsertItem4 Method}}
 
{{#customTitle:IUIX_CmdMenu::InsertItem4 Method}}
 
{{#parentPage:PXV:IUIX_CmdMenu#Methods|InsertItem4|method}}
 
{{#parentPage:PXV:IUIX_CmdMenu#Methods|InsertItem4|method}}
−
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
−
The method of interface of PDF-XChange Editor SDK.
+
Inserts new command menu item with given item ID, data, and style.
  
 
== Syntax ==
 
== Syntax ==
−
<pre class="brush:cpp;gutter:false">HRESULT InsertItem4([in]                              BSTR            pItemID,
+
<pre class="brush:cpp;gutter:false">HRESULT InsertItem4([in]                              BSTR            sItemID,
−
                     [in]                              BSTR            pText,
+
                     [in]                              BSTR            sText,
 
                     [in, defaultvalue(0)]              LONG            nState,
 
                     [in, defaultvalue(0)]              LONG            nState,
 
                     [in, defaultvalue(NULL)]          IUIX_Icon*      pIcon,
 
                     [in, defaultvalue(NULL)]          IUIX_Icon*      pIcon,
−
                     [in, defaultvalue("")]            BSTR            pTip,
+
                     [in, defaultvalue("")]            BSTR            sTip,
 
                     [in, defaultvalue(-1)]            LONG            nIndexBefore,
 
                     [in, defaultvalue(-1)]            LONG            nIndexBefore,
 
                     [in, defaultvalue(0)]              LONG            nStyle,
 
                     [in, defaultvalue(0)]              LONG            nStyle,
−
                     [out, retval, defaultvalue(NULL)]  IUIX_CmdMenu**  ppItem);</pre>
+
                     [out, retval, defaultvalue(NULL)]  IUIX_CmdMenu**  pItem);</pre>
  
 
== Parameters ==
 
== Parameters ==
−
;pItemID
+
;sItemID
−
:[in]  Value of BSTR.
+
:[in]  Value of BSTR containing the command item ID.
−
;pText
+
;sText
−
:[in]  Value of BSTR.
+
:[in]  Value of BSTR containing the text that will be displayed as a command menu item's label.
 
;nState
 
;nState
−
:[in, defaultvalue(0)]  Value of LONG.
+
:[in, defaultvalue(0)]  Value of LONG containing the [[PXV:UIX_CmdItemState|command item's state]].
 
;pIcon
 
;pIcon
−
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IUIX_Icon|IUIX_Icon]].
+
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IUIX_Icon|IUIX_Icon]] containing the command's icon.
−
;pTip
+
;sTip
−
:[in, defaultvalue("")]  Value of BSTR.
+
:[in, defaultvalue("")]  Value of BSTR containing the command's tooltip.
 
;nIndexBefore
 
;nIndexBefore
−
:[in, defaultvalue(-1)]  Value of LONG.
+
:[in, defaultvalue(-1)]  Value of LONG containing the command insertion index.
 
;nStyle
 
;nStyle
−
:[in, defaultvalue(0)]  Value of LONG.
+
:[in, defaultvalue(0)]  Value of LONG containing the [[PXV:UIX_CmdItemStyleFlags|command style flags]].
−
;ppItem
+
;pItem
−
:[out, retval, defaultvalue(NULL)]  Pointer to [[PXV:IUIX_CmdMenu|IUIX_CmdMenu]].
+
:[out, retval, defaultvalue(NULL)]  Pointer to [[PXV:IUIX_CmdMenu|IUIX_CmdMenu]] containing the resulting command menu item.
  
 
== Return Value ==
 
== Return Value ==

Latest revision as of 06:39, 1 April 2016

UI Layer > Interfaces > IUIX_CmdMenu > IUIX_CmdMenu::InsertItem4 Method


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.

See Also

IUIX_CmdMenu

Retrieved from "https://sdkhelp.pdf-xchange.com/index.php?title=PXV:IUIX_CmdMenu_InsertItem4&oldid=49362"