IUIX_RenderContext::DrawString Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
(5 intermediate revisions by one other user not shown) | |||
Line 1: | Line 1: | ||
+ | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IUIX_RenderContext::DrawString Method}} | {{#customTitle:IUIX_RenderContext::DrawString Method}} | ||
− | {{#parentPage:PXV:IUIX_RenderContext|method | + | {{#parentPage:PXV:IUIX_RenderContext#Methods|DrawString|method}} |
− | + | ||
{{ToReview}} | {{ToReview}} | ||
− | + | Used for drawing a sting with specified font and color. | |
== Syntax == | == Syntax == | ||
− | <pre class="brush:cpp;gutter:false">HRESULT DrawString([in] LPWSTR pString, [in] LONG nLength, [in, out] RECT* pRect, [in] IUIX_Font* pFont, [in] LONG nColor, [in] LONG nFlags, [in] RECT* pClipRect, [in, defaultvalue(NULL)] IUIX_ColorsTable* pTagColors, [in, defaultvalue(NULL)] IUIX_DrawStringTags* pTagsOut);</pre> | + | <pre class="brush:cpp;gutter:false">HRESULT DrawString([in] LPWSTR pString, |
+ | [in] LONG nLength, | ||
+ | [in, out] RECT* pRect, | ||
+ | [in] IUIX_Font* pFont, | ||
+ | [in] LONG nColor, | ||
+ | [in] LONG nFlags, | ||
+ | [in] RECT* pClipRect, | ||
+ | [in, defaultvalue(NULL)] IUIX_ColorsTable* pTagColors, | ||
+ | [in, defaultvalue(NULL)] IUIX_DrawStringTags* pTagsOut);</pre> | ||
== Parameters == | == Parameters == | ||
− | ; | + | ;pString |
− | :[in] Value of LPWSTR. | + | :[in] Value of LPWSTR containing the input string. |
− | ; | + | ;nLength |
− | :[in] Value of LONG. | + | :[in] Value of LONG containing the length of the input string. |
− | ; | + | ;pRect |
− | :[in, out] Pointer to RECT. | + | :[in, out] Pointer to RECT containing the rectangle where the string would be drawn. |
− | ; | + | ;pFont |
− | :[in] Pointer to [[PXV:IUIX_Font|IUIX_Font]]. | + | :[in] Pointer to [[PXV:IUIX_Font|IUIX_Font]] containing the needed font. |
− | ; | + | ;nColor |
− | :[in] Value of LONG. | + | :[in] Value of LONG containing the color in the HEX format. |
− | ; | + | ;nFlags |
− | :[in] Value of LONG. | + | :[in] Value of LONG containing the [[PXV:UIX_DrawStringFlags|UIX_DrawStringFlags]]. |
− | ; | + | ;pClipRect |
− | :[in] Pointer to RECT. | + | :[in] Pointer to RECT containing the additional clip rectangle. |
− | ; | + | ;pTagColors |
− | :[in, defaultvalue(NULL)] Pointer to [[PXV:IUIX_ColorsTable|IUIX_ColorsTable]]. | + | :[in, defaultvalue(NULL)] Pointer to [[PXV:IUIX_ColorsTable|IUIX_ColorsTable]] containing the additional colors for tagged text. |
− | ; | + | ;pTagsOut |
− | :[in, defaultvalue(NULL)] Pointer to [[PXV:IUIX_DrawStringTags|IUIX_DrawStringTags]]. | + | :[in, defaultvalue(NULL)] Pointer to [[PXV:IUIX_DrawStringTags|IUIX_DrawStringTags]] containing the new text tags. |
== Return Value == | == Return Value == | ||
Line 34: | Line 42: | ||
== See Also == | == See Also == | ||
− | + | [[PXV:IUIX_RenderContext|IUIX_RenderContext]] |
Latest revision as of 07:23, 13 June 2017
Used for drawing a sting with specified font and color.
Syntax
HRESULT DrawString([in] LPWSTR pString, [in] LONG nLength, [in, out] RECT* pRect, [in] IUIX_Font* pFont, [in] LONG nColor, [in] LONG nFlags, [in] RECT* pClipRect, [in, defaultvalue(NULL)] IUIX_ColorsTable* pTagColors, [in, defaultvalue(NULL)] IUIX_DrawStringTags* pTagsOut);
Parameters
- pString
- [in] Value of LPWSTR containing the input string.
- nLength
- [in] Value of LONG containing the length of the input string.
- pRect
- [in, out] Pointer to RECT containing the rectangle where the string would be drawn.
- pFont
- [in] Pointer to IUIX_Font containing the needed font.
- nColor
- [in] Value of LONG containing the color in the HEX format.
- nFlags
- [in] Value of LONG containing the UIX_DrawStringFlags.
- pClipRect
- [in] Pointer to RECT containing the additional clip rectangle.
- pTagColors
- [in, defaultvalue(NULL)] Pointer to IUIX_ColorsTable containing the additional colors for tagged text.
- pTagsOut
- [in, defaultvalue(NULL)] Pointer to IUIX_DrawStringTags containing the new text tags.
Return Value
Returns S_OK if operation was successful or error code in other cases.