IUIX_CmdBar::InsertSeparator Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(3 intermediate revisions by one other user not shown)
Line 2: Line 2:
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IUIX_CmdBar::InsertSeparator Method}}
 
{{#customTitle:IUIX_CmdBar::InsertSeparator Method}}
{{#parentPage:PXV:IUIX_CmdBar#Methods|InsertSeparator Method|method}}
+
{{#parentPage:PXV:IUIX_CmdBar#Methods|InsertSeparator|method}}
{{ToWrite}}
+
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Inserts separator type [[PXV:IUIX_CmdItem|command item]] into the specified [[PXV:IUIX_CmdItemBox|command items box]].
  
 
== Syntax ==
 
== Syntax ==
Line 12: Line 11:
 
                         [in, defaultvalue(0)]              LONG            nStyle,
 
                         [in, defaultvalue(0)]              LONG            nStyle,
 
                         [in, defaultvalue(0)]              LONG            nBoxIndex,
 
                         [in, defaultvalue(0)]              LONG            nBoxIndex,
                         [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 the index in the command items box wherer the separator will be inserted.
 
;nStyle
 
;nStyle
:[in, defaultvalue(0)]  Value of LONG.
+
:[in, defaultvalue(0)]  Value of LONG containing the [[PXV:UIX_CmdItemStyleFlags|separator's style]].
 
;nBoxIndex
 
;nBoxIndex
:[in, defaultvalue(0)]  Value of LONG.
+
:[in, defaultvalue(0)]  Value of LONG containing the index of the command item box inside the command bar.
;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 28: Line 27:
  
 
== See Also ==
 
== See Also ==
[[PXV:IUIX_CmdBar|IUIX_CmdBar]].
+
[[PXV:IUIX_CmdBar|IUIX_CmdBar]]

Latest revision as of 04:47, 25 March 2016


Inserts separator type command item into the specified command items box.

Syntax

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

Parameters

nIndexBefore
[in, defaultvalue(-1)] Value of LONG the index in the command items box wherer the separator will be inserted.
nStyle
[in, defaultvalue(0)] Value of LONG containing the separator's style.
nBoxIndex
[in, defaultvalue(0)] Value of LONG containing the index of the command item box inside the command bar.
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_CmdBar