IUIX_Inst::CreateLabel Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(6 intermediate revisions by 2 users not shown)
Line 2: Line 2:
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IUIX_Inst::CreateLabel Method}}
 
{{#customTitle:IUIX_Inst::CreateLabel Method}}
−
{{#parentPage:PXV:IUIX_Inst|CreateLabel Method|method}}
+
{{#parentPage:PXV:IUIX_Inst#Methods|CreateLabel|method}}
−
{{ToWrite}}
+
−
{{ToReview}}
+
  
−
The method of interface of PDF-XChange Editor SDK.
+
 
 +
Creates new object of [[PXV:IUIX_Label|IUIX_Label]] interface.
  
 
== Syntax ==
 
== Syntax ==
Line 15: Line 14:
 
                     [in, defaultvalue(0)]              LONGLONG      nStyle,
 
                     [in, defaultvalue(0)]              LONGLONG      nStyle,
 
                     [in, defaultvalue(NULL)]          IUnknown*    pCustomImpl,
 
                     [in, defaultvalue(NULL)]          IUnknown*    pCustomImpl,
−
                     [out, retval, defaultvalue(NULL)]  IUIX_Label**  ppLabel);</pre>
+
                     [out, retval, defaultvalue(NULL)]  IUIX_Label**  pLabel);</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 a created object will be located.
 
;pID
 
;pID
−
:[in]  Value of BSTR.
+
:[in]  string ID of created object.
 
;pText
 
;pText
−
:[in]  Value of BSTR.
+
:[in]  specifies label text.
 
;nStyle
 
;nStyle
−
:[in, defaultvalue(0)]  Value of LONGLONG.
+
:[in, defaultvalue(0)]  specifies label style flags from [[PXV:UIX_LabelStyleFlags|UIX_LabelStyleFlags]] enumeration.  
 
;pCustomImpl
 
;pCustomImpl
−
:[in, optional]  Pointer to IUnknown*.
+
:[in, optional]  custom implementation of [[PXV:IUIX_Label|IUIX_Label]] interface. Set this parameter if you need to use your own interface implementation instead of default one.
−
;ppLabel
+
;pLabel
−
:[out, retval, defaultvalue(NULL)]  Pointer to [[PXV:IUIX_Label|IUIX_Label]].
+
:[out, retval, defaultvalue(NULL)]  return object of [[PXV:IUIX_Label|IUIX_Label]] 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 09:00, 16 June 2015

UI Layer > Interfaces > IUIX_Inst > IUIX_Inst::CreateLabel Method


Creates new object of IUIX_Label interface.

Syntax

HRESULT CreateLabel([in]                               IUIX_Obj*     pParent,
                    [in]                               RECT*         pRect,
                    [in]                               BSTR          pID,
                    [in]                               BSTR          pText,
                    [in, defaultvalue(0)]              LONGLONG      nStyle,
                    [in, defaultvalue(NULL)]           IUnknown*     pCustomImpl,
                    [out, retval, defaultvalue(NULL)]  IUIX_Label**  pLabel);

Parameters

pParent
[in] parent object.
pRect
[in] dialog area where a created object will be located.
pID
[in] string ID of created object.
pText
[in] specifies label text.
nStyle
[in, defaultvalue(0)] specifies label style flags from UIX_LabelStyleFlags enumeration.
pCustomImpl
[in, optional] custom implementation of IUIX_Label interface. Set this parameter if you need to use your own interface implementation instead of default one.
pLabel
[out, retval, defaultvalue(NULL)] return object of IUIX_Label 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_CreateLabel&oldid=47574"