IUIX_CmdBar::InsertNewBox Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
Line 1: Line 1:
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IUIX_CmdBar::InsertNewBox Method}}
 
{{#customTitle:IUIX_CmdBar::InsertNewBox Method}}
{{#parentPage:PXV:IUIX_CmdBar|method}}
+
{{#parentPage:PXV:IUIX_CmdBar|InsertNewBox Method|method}}
 
{{ToWrite}}
 
{{ToWrite}}
 
{{ToReview}}
 
{{ToReview}}
Line 8: Line 8:
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT InsertNewBox([in] BSTR pNewBoxID, [in, defaultvalue(-1)] LONG nInsertBefore, [in, defaultvalue(UIX_CmdItemSize_Default)] UIX_CmdItemSize nIdealSize, [in, defaultvalue(UIX_CmdItemSize_Default)] UIX_CmdItemSize nLowerSize, [in, defaultvalue(0)] LONG nStyle, [out, retval, defaultvalue(NULL)] IUIX_CmdItemBox** ppItemBox);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT InsertNewBox([in]                                         BSTR               pNewBoxID,
 +
                    [in, defaultvalue(-1)]                       LONG               nInsertBefore,
 +
                    [in, defaultvalue(UIX_CmdItemSize_Default)] UIX_CmdItemSize   nIdealSize,
 +
                    [in, defaultvalue(UIX_CmdItemSize_Default)] UIX_CmdItemSize   nLowerSize,
 +
                    [in, defaultvalue(0)]                       LONG               nStyle,
 +
                    [out, retval, defaultvalue(NULL)]           IUIX_CmdItemBox** ppItemBox);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pNewBoxID''
+
;pNewBoxID
 
:[in]  Value of BSTR.
 
:[in]  Value of BSTR.
;''nInsertBefore''
+
;nInsertBefore
 
:[in, defaultvalue(-1)]  Value of LONG.
 
:[in, defaultvalue(-1)]  Value of LONG.
;''nIdealSize''
+
;nIdealSize
 
:[in, defaultvalue(UIX_CmdItemSize_Default)]  Value of [[PXV:UIX_CmdItemSize|UIX_CmdItemSize]].
 
:[in, defaultvalue(UIX_CmdItemSize_Default)]  Value of [[PXV:UIX_CmdItemSize|UIX_CmdItemSize]].
;''nLowerSize''
+
;nLowerSize
 
:[in, defaultvalue(UIX_CmdItemSize_Default)]  Value of [[PXV:UIX_CmdItemSize|UIX_CmdItemSize]].
 
:[in, defaultvalue(UIX_CmdItemSize_Default)]  Value of [[PXV:UIX_CmdItemSize|UIX_CmdItemSize]].
;''nStyle''
+
;nStyle
 
:[in, defaultvalue(0)]  Value of LONG.
 
:[in, defaultvalue(0)]  Value of LONG.
;''ppItemBox''
+
;ppItemBox
 
:[out, retval, defaultvalue(NULL)]  Pointer to [[PXV:IUIX_CmdItemBox|IUIX_CmdItemBox]].
 
:[out, retval, defaultvalue(NULL)]  Pointer to [[PXV:IUIX_CmdItemBox|IUIX_CmdItemBox]].
  

Revision as of 06:35, 23 April 2015


The method of interface of PDF-XChange Editor SDK.

Syntax

HRESULT InsertNewBox([in]                                         BSTR               pNewBoxID,
                     [in, defaultvalue(-1)]                       LONG               nInsertBefore,
                     [in, defaultvalue(UIX_CmdItemSize_Default)]  UIX_CmdItemSize    nIdealSize,
                     [in, defaultvalue(UIX_CmdItemSize_Default)]  UIX_CmdItemSize    nLowerSize,
                     [in, defaultvalue(0)]                        LONG               nStyle,
                     [out, retval, defaultvalue(NULL)]            IUIX_CmdItemBox**  ppItemBox);

Parameters

pNewBoxID
[in] Value of BSTR.
nInsertBefore
[in, defaultvalue(-1)] Value of LONG.
nIdealSize
[in, defaultvalue(UIX_CmdItemSize_Default)] Value of UIX_CmdItemSize.
nLowerSize
[in, defaultvalue(UIX_CmdItemSize_Default)] Value of UIX_CmdItemSize.
nStyle
[in, defaultvalue(0)] Value of LONG.
ppItemBox
[out, retval, defaultvalue(NULL)] Pointer to IUIX_CmdItemBox.

Return Value

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

See Also

See also IUIX_CmdBar.