IUIX_Inst::CreateButton Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IUIX_Inst::CreateButton Method}}
 
{{#customTitle:IUIX_Inst::CreateButton Method}}
−
{{#parentPage:PXV:IUIX_Inst|method}}
+
{{#parentPage:PXV:IUIX_Inst#Methods|CreateButton|method}}
−
{{ToWrite}}
+
−
{{ToReview}}
+
  
−
The method of interface of PDF-XChange Editor SDK.
+
 
 +
Creates object of [[PXV:IUIX_Button|IUIX_Button]] interface.
  
 
== Syntax ==
 
== Syntax ==
−
<pre class="brush:cpp;gutter:false">HRESULT CreateButton([in] IUIX_Obj* pParent, [in] RECT* pRect, [in] BSTR pID, [in] BSTR pText, [in, defaultvalue(0)] LONGLONG nStyle, [in, optional] IUnknown* pImageOrIcon, [in, optional] IUnknown* pCustomImpl, [out, retval] IUIX_Button** ppButton);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT CreateButton([in]                     IUIX_Obj*     pParent,
 +
                    [in]                     RECT*         pRect,
 +
                    [in]                     BSTR           pID,
 +
                    [in]                     BSTR           pText,
 +
                    [in, defaultvalue(0)]     LONGLONG       nStyle,
 +
                    [in, defaultvalue(NULL)] IUnknown*     pImageOrIcon,
 +
                    [in, defaultvalue(NULL)] IUnknown*     pCustomImpl,
 +
                    [out, retval]             IUIX_Button** pButton);</pre>
  
 
== Parameters ==
 
== Parameters ==
−
;''pParent''
+
;pParent
−
:[in]  Pointer to [[PXV:IUIX_Obj|IUIX_Obj]].
+
:[in]  parent object.
−
;''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.
−
;''pText''
+
;pText
−
:[in]  Value of BSTR.
+
:[in]  text of the button.
−
;''nStyle''
+
;nStyle
−
:[in, defaultvalue(0)]  Value of LONGLONG.
+
:[in, defaultvalue(0)]  button style flags. See [[PXV:UIX_ButtonStyleFlags|UIX_ButtonStyleFlags]] for full list of button style flags.
−
;''pImageOrIcon''
+
;pImageOrIcon
−
:[in, optional]  Pointer to IUnknown*.
+
:[in, optional]  button image. '''pImageOrIcon''' object must implement [[PXV:IUIX_Icon|IUIX_Icon]] or [[PXV:IUIX_ImageData|IUIX_ImageData]] interface.
−
;''pCustomImpl''
+
;pCustomImpl
−
:[in, optional]  Pointer to IUnknown*.
+
:[in, optional]  custom implementation of [[PXV:IUIX_Button|IUIX_Button]] interface. Set this parameter if you need to use your own interface implementation instead of default one.
−
;''ppButton''
+
;pButton
−
:[out, retval]  Pointer to [[PXV:IUIX_Button|IUIX_Button]].
+
:[out, retval]  return object of [[PXV:IUIX_Button|IUIX_Button]] 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 15:39, 15 June 2015

UI Layer > Interfaces > IUIX_Inst > IUIX_Inst::CreateButton Method


Creates object of IUIX_Button interface.

Syntax

HRESULT CreateButton([in]                      IUIX_Obj*      pParent,
                     [in]                      RECT*          pRect,
                     [in]                      BSTR           pID,
                     [in]                      BSTR           pText,
                     [in, defaultvalue(0)]     LONGLONG       nStyle,
                     [in, defaultvalue(NULL)]  IUnknown*      pImageOrIcon,
                     [in, defaultvalue(NULL)]  IUnknown*      pCustomImpl,
                     [out, retval]             IUIX_Button**  pButton);

Parameters

pParent
[in] parent object.
pRect
[in] dialog area where created object will be located.
pID
[in] string ID of created object.
pText
[in] text of the button.
nStyle
[in, defaultvalue(0)] button style flags. See UIX_ButtonStyleFlags for full list of button style flags.
pImageOrIcon
[in, optional] button image. pImageOrIcon object must implement IUIX_Icon or IUIX_ImageData interface.
pCustomImpl
[in, optional] custom implementation of IUIX_Button interface. Set this parameter if you need to use your own interface implementation instead of default one.
pButton
[out, retval] return object of IUIX_Button interface.

Return Value

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

See Also

IUIX_Inst

Retrieved from "https://sdkhelp.pdf-xchange.com/index.php?title=PXV:IUIX_Inst_CreateButton&oldid=47538"