IUIX_CmdItemBox::InsertSeparator Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(4 intermediate revisions by one other user not shown)
Line 2: Line 2:
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IUIX_CmdItemBox::InsertSeparator Method}}
 
{{#customTitle:IUIX_CmdItemBox::InsertSeparator Method}}
{{#parentPage:PXV:IUIX_CmdItemBox|InsertSeparator Method|method}}
+
{{#parentPage:PXV:IUIX_CmdItemBox#Methods|InsertSeparator|method}}
{{ToWrite}}
+
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Inserts separator [[PXV:IUIX_CmdItem|command item]] into the command items box.
  
 
== Syntax ==
 
== Syntax ==
 
<pre class="brush:cpp;gutter:false">HRESULT InsertSeparator([in, defaultvalue(-1)]            LONG            nIndexBefore,
 
<pre class="brush:cpp;gutter:false">HRESULT InsertSeparator([in, defaultvalue(-1)]            LONG            nIndexBefore,
 
                         [in, defaultvalue(0)]              LONG            nStyle,
 
                         [in, defaultvalue(0)]              LONG            nStyle,
                         [out, retval, defaultvalue(NULL)]  IUIX_CmdItem**  ppItem);</pre>
+
                         [out, retval, defaultvalue(NULL)]  IUIX_CmdItem**  pItem);</pre>
  
 
== Parameters ==
 
== Parameters ==
 
;nIndexBefore
 
;nIndexBefore
:[in, defaultvalue(-1)]  Value of LONG.
+
:[in, defaultvalue(-1)]  Value of LONG containing the separator's insert index.
 
;nStyle
 
;nStyle
:[in, defaultvalue(0)]  Value of LONG.
+
:[in, defaultvalue(0)]  Value of LONG containing the [[PXV:UIX_CmdItemStyleFlags|separator's style]].
;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 separator.
  
 
== Return Value ==
 
== Return Value ==
Line 25: Line 24:
  
 
== See Also ==
 
== See Also ==
[[PXV:IUIX_CmdItemBox|IUIX_CmdItemBox]].
+
[[PXV:IUIX_CmdItemBox|IUIX_CmdItemBox]]

Latest revision as of 07:17, 24 March 2016


Inserts separator command item into the command items box.

Syntax

HRESULT InsertSeparator([in, defaultvalue(-1)]             LONG            nIndexBefore,
                        [in, defaultvalue(0)]              LONG            nStyle,
                        [out, retval, defaultvalue(NULL)]  IUIX_CmdItem**  pItem);

Parameters

nIndexBefore
[in, defaultvalue(-1)] Value of LONG containing the separator's insert index.
nStyle
[in, defaultvalue(0)] Value of LONG containing the separator's style.
pItem
[out, retval, defaultvalue(NULL)] Pointer to IUIX_CmdItem containing the newly inserted separator.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

IUIX_CmdItemBox