IPXC_ContentCreator::ShowTextBlock Method

Revision as of 22:37, 4 July 2016

Shows text block in the specified rectangle and calculates the text bounds. If the callbacks are specified then the callback's methods will be used.

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 containing the text that needs to be shown.

pRect

[in] Pointer to PXC_Rect containing the rectangle into which the text will be placed.

pClip

[in] Pointer to PXC_Rect containing the clip that would be applied to the text. Can be null.

nFlags

[in, defaultvalue(0)] Value of ULONG containing the draw text flags.

nTextLen

[in, defaultvalue(-1)] Value of LONG containing the length of the text.

pCharFmt

[in, defaultvalue(NULL)] Pointer to IPXC_CharFormat containing the text's custom character format.

pParaFmt

[in, defaultvalue(NULL)] Pointer to IPXC_ParaFormat containing the text's custom paragraph format.

pCallbacks

[in, defaultvalue(NULL)] Pointer to IPXC_DrawTextCallbacks containing the callbacks.

pTextBounds

[out, defaultvalue(NULL)] Pointer to PXC_Rect containing the resulting bound rectangle of the given text.

Return Value

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

See Also

IPXC_ContentCreator