IUIX_CmdItemBox::InsertItem Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(6 intermediate revisions by 2 users not shown)
Line 2: Line 2:
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IUIX_CmdItemBox::InsertItem Method}}
 
{{#customTitle:IUIX_CmdItemBox::InsertItem Method}}
{{#parentPage:PXV:IUIX_CmdItemBox|InsertItem Method|method}}
+
{{#parentPage:PXV:IUIX_CmdItemBox#Methods|InsertItem|method}}
{{ToWrite}}
+
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Inserts new [[PXV:IUIX_CmdItem|command item]] in the command items box that is related to the given command.
  
 
== Syntax ==
 
== Syntax ==
Line 13: Line 13:
 
                   [in, defaultvalue(0)]              LONG            nNewStyle,
 
                   [in, defaultvalue(0)]              LONG            nNewStyle,
 
                   [in, defaultvalue(0)]              LONG            nNewStyleMask,
 
                   [in, defaultvalue(0)]              LONG            nNewStyleMask,
                   [out, retval, defaultvalue(NULL)]  IUIX_CmdItem**  ppItem);</pre>
+
                   [out, retval, defaultvalue(NULL)]  IUIX_CmdItem**  pItem);</pre>
  
 
== Parameters ==
 
== Parameters ==
 
;pCmd
 
;pCmd
:[in]  Pointer to [[PXV:IUIX_Cmd|IUIX_Cmd]].
+
:[in]  Pointer to [[PXV:IUIX_Cmd|IUIX_Cmd]] containing the command that will be inserted.
 
;nIndexBefore
 
;nIndexBefore
:[in, defaultvalue(-1)]  Value of LONG.
+
:[in, defaultvalue(-1)]  Value of LONG containing the command item 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.
;ppItem
+
;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 31: Line 31:
  
 
== See Also ==
 
== See Also ==
[[PXV:IUIX_CmdItemBox|IUIX_CmdItemBox]].
+
[[PXV:IUIX_CmdItemBox|IUIX_CmdItemBox]]

Latest revision as of 07:15, 24 March 2016


Inserts new command item in the command items box that is related to the given command.

Syntax

HRESULT InsertItem([in]                               IUIX_Cmd*       pCmd,
                   [in, defaultvalue(-1)]             LONG            nIndexBefore,
                   [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 will be inserted.
nIndexBefore
[in, defaultvalue(-1)] Value of LONG containing the command item 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.
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.

See Also

IUIX_CmdItemBox