IUIX_Inst::CreateLabel Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 3: Line 3:
 
{{#customTitle:IUIX_Inst::CreateLabel Method}}
 
{{#customTitle:IUIX_Inst::CreateLabel Method}}
 
{{#parentPage:PXV:IUIX_Inst|CreateLabel Method|method}}
 
{{#parentPage:PXV:IUIX_Inst|CreateLabel Method|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Creates new object of [[PXV:IUIX_Label|IUIX_Label]] interface.
  
 
== Syntax ==
 
== Syntax ==
Line 19: Line 18:
 
== 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]  Value of BSTR.
 
;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
 
;ppLabel
:[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 ==

Revision as of 07:31, 20 May 2015


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**  ppLabel);

Parameters

pParent
[in] parent object.
pRect
[in] dialog area where created object will be located.
pID
[in] string ID of created object.
pText
[in] Value of BSTR.
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.
ppLabel
[out, retval, defaultvalue(NULL)] return object of IUIX_Label interface.

Return Value

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

See Also

IUIX_Inst.