IUIX_Inst::CreateTree Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(5 intermediate revisions by 2 users not shown)
Line 2: Line 2:
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IUIX_Inst::CreateTree Method}}
 
{{#customTitle:IUIX_Inst::CreateTree Method}}
{{#parentPage:PXV:IUIX_Inst|CreateTree Method|method}}
+
{{#parentPage:PXV:IUIX_Inst#Methods|CreateTree|method}}
{{ToWrite}}
+
{{ToReview}}
+
  
The method of interface of PDF-XChange Editor SDK.
+
 
 +
Creates new ''tree'' object of [[PXV:IUIX_Tree|IUIX_Tree]] interface.
  
 
== Syntax ==
 
== Syntax ==
Line 15: Line 14:
 
                   [in, defaultvalue(0)]              LONGLONG    nScrollStyle,
 
                   [in, defaultvalue(0)]              LONGLONG    nScrollStyle,
 
                   [in, defaultvalue(NULL)]          IUnknown*    pCustomImpl,
 
                   [in, defaultvalue(NULL)]          IUnknown*    pCustomImpl,
                   [out, retval, defaultvalue(NULL)]  IUIX_Tree**  ppTree);</pre>
+
                   [out, retval, defaultvalue(NULL)]  IUIX_Tree**  pTree);</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 the style of the tree with flags from [[PXV:UIX_TreeStyleFlags|UIX_TreeStyleFlags]] enumeration.
 
;nScrollStyle
 
;nScrollStyle
:[in, defaultvalue(0)]  Value of LONGLONG.
+
:[in, defaultvalue(0)]  specifies scroll style with flags from [[PXV:UIX_ScrollStyleFlags|UIX_ScrollStyleFlags]] enumeration.
 
;pCustomImpl
 
;pCustomImpl
:[in, optional]  Pointer to IUnknown*.
+
:[in, optional]  custom implementation of [[PXV:IUIX_Tree|IUIX_Tree]] interface. Set this parameter if you need to use your own interface implementation instead of default one.
;ppTree
+
;pTree
:[out, retval, defaultvalue(NULL)]  Pointer to [[PXV:IUIX_Tree|IUIX_Tree]].
+
:[out, retval, defaultvalue(NULL)]  return object of [[PXV:IUIX_Tree|IUIX_Tree]] 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 ==
[[PXV:IUIX_Inst|IUIX_Inst]].
+
[[PXV:IUIX_Inst|IUIX_Inst]]

Latest revision as of 11:27, 16 June 2015


Creates new tree object of IUIX_Tree interface.

Syntax

HRESULT CreateTree([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_Tree**  pTree);

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 the style of the tree with flags from UIX_TreeStyleFlags enumeration.
nScrollStyle
[in, defaultvalue(0)] specifies scroll style with flags from UIX_ScrollStyleFlags enumeration.
pCustomImpl
[in, optional] custom implementation of IUIX_Tree interface. Set this parameter if you need to use your own interface implementation instead of default one.
pTree
[out, retval, defaultvalue(NULL)] return object of IUIX_Tree interface.

Return Value

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

See Also

IUIX_Inst