IPXC_ContentCreator::ShowTextBlock Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
Line 5: Line 5:
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT ShowTextBlock([in] LPWSTR pText, [in] PXC_Rect* pRect, [in] PXC_Rect* pClip, [in, optional] ULONG nFlags, [in, optional] LONG nTextLen, [in, optional] IPXC_CharFormat* pCharFmt, [in, optional] IPXC_ParaFormat* pParaFmt, [in, optional] IPXC_DrawTextCallbacks* pCallbacks, [out, optional] PXC_Rect* pTextBounds);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT ShowTextBlock([in] LPWSTR pText, [in] PXC_Rect* pRect, [in] PXC_Rect* pClip, [in, defaultvalue(0)] ULONG nFlags, [in, defaultvalue(-1)] LONG nTextLen, [in, defaultvalue(NULL)] IPXC_CharFormat* pCharFmt, [in, defaultvalue(NULL)] IPXC_ParaFormat* pParaFmt, [in, defaultvalue(NULL)] IPXC_DrawTextCallbacks* pCallbacks, [out, defaultvalue(NULL)] PXC_Rect* pTextBounds);</pre>
  
 
== Parameters ==
 
== Parameters ==
Line 15: Line 15:
 
:[in]  Pointer to [[PXV:PXC_Rect|PXC_Rect]].
 
:[in]  Pointer to [[PXV:PXC_Rect|PXC_Rect]].
 
;''nFlags''
 
;''nFlags''
:[in, optional]  Value of ULONG.
+
:[in, defaultvalue(0)]  Value of ULONG.
 
;''nTextLen''
 
;''nTextLen''
:[in, optional]  Value of LONG.
+
:[in, defaultvalue(-1)]  Value of LONG.
 
;''pCharFmt''
 
;''pCharFmt''
:[in, optional]  Pointer to [[PXV:IPXC_CharFormat|IPXC_CharFormat]].
+
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IPXC_CharFormat|IPXC_CharFormat]].
 
;''pParaFmt''
 
;''pParaFmt''
:[in, optional]  Pointer to [[PXV:IPXC_ParaFormat|IPXC_ParaFormat]].
+
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IPXC_ParaFormat|IPXC_ParaFormat]].
 
;''pCallbacks''
 
;''pCallbacks''
:[in, optional]  Pointer to [[PXV:IPXC_DrawTextCallbacks|IPXC_DrawTextCallbacks]].
+
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IPXC_DrawTextCallbacks|IPXC_DrawTextCallbacks]].
 
;''pTextBounds''
 
;''pTextBounds''
:[out, optional]  Pointer to [[PXV:PXC_Rect|PXC_Rect]].
+
:[out, defaultvalue(NULL)]  Pointer to [[PXV:PXC_Rect|PXC_Rect]].
  
 
== Return Value ==
 
== Return Value ==

Revision as of 23:39, 16 April 2015

The method of interface of PDF-XChange Editor SDK.

Syntax

HRESULT ShowTextBlock([in] LPWSTR pText, [in] PXC_Rect* pRect, [in] PXC_Rect* pClip, [in, defaultvalue(0)] ULONG nFlags, [in, defaultvalue(-1)] LONG nTextLen, [in, defaultvalue(NULL)] IPXC_CharFormat* pCharFmt, [in, defaultvalue(NULL)] IPXC_ParaFormat* pParaFmt, [in, defaultvalue(NULL)] IPXC_DrawTextCallbacks* pCallbacks, [out, defaultvalue(NULL)] PXC_Rect* pTextBounds);

Parameters

pText
[in] Value of LPWSTR.
pRect
[in] Pointer to PXC_Rect.
pClip
[in] Pointer to PXC_Rect.
nFlags
[in, defaultvalue(0)] Value of ULONG.
nTextLen
[in, defaultvalue(-1)] Value of LONG.
pCharFmt
[in, defaultvalue(NULL)] Pointer to IPXC_CharFormat.
pParaFmt
[in, defaultvalue(NULL)] Pointer to IPXC_ParaFormat.
pCallbacks
[in, defaultvalue(NULL)] Pointer to IPXC_DrawTextCallbacks.
pTextBounds
[out, defaultvalue(NULL)] Pointer to PXC_Rect.

Return Value

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

See Also

See also IPXC_ContentCreator.