IUIX_RenderContext::DrawString Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
Line 1: Line 1:
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IUIX_RenderContext::DrawString Method}}
 
{{#customTitle:IUIX_RenderContext::DrawString Method}}
{{#parentPage:PXV:IUIX_RenderContext|method}}
+
{{#parentPage:PXV:IUIX_RenderContext|DrawString Method|method}}
 
{{ToWrite}}
 
{{ToWrite}}
 
{{ToReview}}
 
{{ToReview}}
Line 8: Line 8:
  
 
== 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''
+
;pString
 
:[in]  Value of LPWSTR.
 
:[in]  Value of LPWSTR.
;''nLength''
+
;nLength
 
:[in]  Value of LONG.
 
:[in]  Value of LONG.
;''pRect''
+
;pRect
 
:[in, out]  Pointer to RECT.
 
:[in, out]  Pointer to RECT.
;''pFont''
+
;pFont
 
:[in]  Pointer to [[PXV:IUIX_Font|IUIX_Font]].
 
:[in]  Pointer to [[PXV:IUIX_Font|IUIX_Font]].
;''nColor''
+
;nColor
 
:[in]  Value of LONG.
 
:[in]  Value of LONG.
;''nFlags''
+
;nFlags
 
:[in]  Value of LONG.
 
:[in]  Value of LONG.
;''pClipRect''
+
;pClipRect
 
:[in]  Pointer to RECT.
 
:[in]  Pointer to RECT.
;''pTagColors''
+
;pTagColors
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IUIX_ColorsTable|IUIX_ColorsTable]].
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IUIX_ColorsTable|IUIX_ColorsTable]].
;''pTagsOut''
+
;pTagsOut
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IUIX_DrawStringTags|IUIX_DrawStringTags]].
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IUIX_DrawStringTags|IUIX_DrawStringTags]].
  

Revision as of 06:54, 23 April 2015


The method of interface of PDF-XChange Editor SDK.

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.
nLength
[in] Value of LONG.
pRect
[in, out] Pointer to RECT.
pFont
[in] Pointer to IUIX_Font.
nColor
[in] Value of LONG.
nFlags
[in] Value of LONG.
pClipRect
[in] Pointer to RECT.
pTagColors
[in, defaultvalue(NULL)] Pointer to IUIX_ColorsTable.
pTagsOut
[in, defaultvalue(NULL)] Pointer to IUIX_DrawStringTags.

Return Value

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

See Also

See also IUIX_RenderContext.