IUIX_Inst::CreateEdit Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IUIX_Inst::CreateEdit Method}}
 
{{#customTitle:IUIX_Inst::CreateEdit Method}}
 +
{{#parentPage:PXV:IUIX_Inst#Methods|CreateEdit|method}}
  
The method of interface of PDF-XChange Editor SDK.
+
 
 +
Creates new object of [[PXV:IUIX_Edit|IUIX_Edit]] interface.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT CreateEdit([in] IUIX_Obj* pParent, [in] RECT* pRect, [in] BSTR pID, [in, defaultvalue(0)] LONGLONG nStyle, [in, defaultvalue(0)] LONGLONG nScrollStyle, [in, optional] IUnknown* pCustomImpl, [out, retval, defaultvalue(NULL)] IUIX_Edit** ppEdit);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT CreateEdit([in]                               IUIX_Obj*   pParent,
 +
                  [in]                               RECT*       pRect,
 +
                  [in]                               BSTR         pID,
 +
                  [in, defaultvalue(0)]             LONGLONG     nStyle,
 +
                  [in, defaultvalue(0)]             LONGLONG     nScrollStyle,
 +
                  [in, defaultvalue(NULL)]           IUnknown*   pCustomImpl,
 +
                  [out, retval, defaultvalue(NULL)] IUIX_Edit** pEdit);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pParent''
+
;pParent
:[in]  Pointer to [[PXV:IUIX_Obj|IUIX_Obj]].
+
:[in]  parent object of [[PXV:IUIX_Obj|IUIX_Obj]] interface.
;''pRect''
+
;pRect
:[in]  Pointer to RECT.
+
:[in]  dialog area where created object will be located.
;''pID''
+
;pID
:[in]  Value of BSTR.
+
:[in]  string ID of created object.
;''nStyle''
+
;nStyle
:[in, defaultvalue(0)]  Value of LONGLONG.
+
:[in, defaultvalue(0)]  specifies edit style flags from [[PXV:UIX_EditStyleFlags|UIX_EditStyleFlags]] enumeration.
;''nScrollStyle''
+
;nScrollStyle
:[in, defaultvalue(0)]  Value of LONGLONG.
+
:[in, defaultvalue(0)]  specifies scroll style flags from [[PXV:UIX_ScrollStyleFlags|UIX_ScrollStyleFlags]] enumeration.
;''pCustomImpl''
+
;pCustomImpl
:[in, optional] Pointer to IUnknown*.
+
:[in, optional] specifies custom implementation of [[PXV:IUIX_Edit|IUIX_Edit]] interface. Set this parameter if you need to use your own interface implementation instead of default one.
;''ppEdit''
+
;pEdit
:[out, retval, defaultvalue(NULL)]  Pointer to [[PXV:IUIX_Edit|IUIX_Edit]].
+
:[out, retval, defaultvalue(NULL)]  return object of [[PXV:IUIX_Edit|IUIX_Edit]] interface.
  
 
== Return Value ==
 
== Return Value ==
Returns S_OK if operation was successful or error code in other cases.
+
Returns S_OK if the operation was successful, or will return an error code if it fails.  
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IUIX_Inst|IUIX_Inst]].
+
[[PXV:IUIX_Inst|IUIX_Inst]]

Latest revision as of 17:27, 15 June 2015


Creates new object of IUIX_Edit interface.

Syntax

HRESULT CreateEdit([in]                               IUIX_Obj*    pParent,
                   [in]                               RECT*        pRect,
                   [in]                               BSTR         pID,
                   [in, defaultvalue(0)]              LONGLONG     nStyle,
                   [in, defaultvalue(0)]              LONGLONG     nScrollStyle,
                   [in, defaultvalue(NULL)]           IUnknown*    pCustomImpl,
                   [out, retval, defaultvalue(NULL)]  IUIX_Edit**  pEdit);

Parameters

pParent
[in] parent object of IUIX_Obj interface.
pRect
[in] dialog area where created object will be located.
pID
[in] string ID of created object.
nStyle
[in, defaultvalue(0)] specifies edit style flags from UIX_EditStyleFlags enumeration.
nScrollStyle
[in, defaultvalue(0)] specifies scroll style flags from UIX_ScrollStyleFlags enumeration.
pCustomImpl
[in, optional] specifies custom implementation of IUIX_Edit interface. Set this parameter if you need to use your own interface implementation instead of default one.
pEdit
[out, retval, defaultvalue(NULL)] return object of IUIX_Edit interface.

Return Value

Returns S_OK if the operation was successful, or will return an error code if it fails.

See Also

IUIX_Inst