IUIX_CmdPane::InsertLine Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
 
(9 intermediate revisions by one other user not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IUIX_CmdPane::InsertLine Method}}
 
{{#customTitle:IUIX_CmdPane::InsertLine Method}}
 +
{{#parentPage:PXV:IUIX_CmdPane#Methods|InsertLine|method}}
 +
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Inserts new [[PXV:IUIX_CmdLine|command line]] into the command pane.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT InsertLine([in, optional] LONG nIndexBefore, [in, optional] VARIANT_BOOL bMinimized, [out, retval, optional] IUIX_CmdLine** ppNewLine);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT InsertLine([in, defaultvalue(-1)] LONG           nIndexBefore,
 +
                  [in, defaultvalue(0)]   VARIANT_BOOL   bMinimized,
 +
                  [out, retval]           IUIX_CmdLine** pNewLine);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''nIndexBefore''
+
;nIndexBefore
:[in, optional]  Value of LONG.
+
:[in, defaultvalue(-1)]  Value of LONG containing the new line insert index.
;''bMinimized''
+
;bMinimized
:[in, optional]  Value of VARIANT_BOOL.
+
:[in, defaultvalue(0)]  Value of VARIANT_BOOL that specifies whether the newly inserted line should be minimized.
;''ppNewLine''
+
;pNewLine
:[out, retval, optional]  Pointer to [[PXV:IUIX_CmdLine|IUIX_CmdLine]].
+
:[out, retval]  Pointer to [[PXV:IUIX_CmdLine|IUIX_CmdLine]] containing the newly created command line.
  
 
== Return Value ==
 
== Return Value ==
Line 19: Line 24:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IUIX_CmdPane|IUIX_CmdPane]].
+
[[PXV:IUIX_CmdPane|IUIX_CmdPane]]

Latest revision as of 03:15, 25 March 2016


Inserts new command line into the command pane.

Syntax

HRESULT InsertLine([in, defaultvalue(-1)]  LONG            nIndexBefore,
                   [in, defaultvalue(0)]   VARIANT_BOOL    bMinimized,
                   [out, retval]           IUIX_CmdLine**  pNewLine);

Parameters

nIndexBefore
[in, defaultvalue(-1)] Value of LONG containing the new line insert index.
bMinimized
[in, defaultvalue(0)] Value of VARIANT_BOOL that specifies whether the newly inserted line should be minimized.
pNewLine
[out, retval] Pointer to IUIX_CmdLine containing the newly created command line.

Return Value

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

See Also

IUIX_CmdPane