IUIX_Obj::CalcStringSize Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
 
(7 intermediate revisions by one other user not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IUIX_Obj::CalcStringSize Method}}
 
{{#customTitle:IUIX_Obj::CalcStringSize Method}}
 +
{{#parentPage:PXV:IUIX_Obj#Methods|CalcStringSize|method}}
 +
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Calculates size in points for the given string.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT CalcStringSize([in] LPWSTR pString, [in] LONG nLength, [in] IUIX_Font* pFont, [in, out] SIZE* pSize, [in, optional] LONG nFlags);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT CalcStringSize([in]                   LPWSTR     pString,
 +
                      [in]                   LONG       nLength,
 +
                      [in]                   IUIX_Font* pFont,
 +
                      [in, out]             SIZE*       pSize,
 +
                      [in, defaultvalue(0)] LONG       nFlags);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pString''
+
;pString
:[in]  Value of LPWSTR.
+
:[in]  Value of LPWSTR containing the string with text.
;''nLength''
+
;nLength
:[in]  Value of LONG.
+
:[in]  Value of LONG containing the length of the string.
;''pFont''
+
;pFont
:[in]  Pointer to [[PXV:IUIX_Font|IUIX_Font]].
+
:[in]  Pointer to [[PXV:IUIX_Font|IUIX_Font]] containing a font that is being used.
;''pSize''
+
;pSize
:[in, out]  Pointer to SIZE.
+
:[in, out]  Pointer to SIZE containing the resulting string size.
;''nFlags''
+
;nFlags
:[in, optional]  Value of LONG.
+
:[in, defaultvalue(0)]  Value of LONG containing the [[PXV:UIX_DrawStringFlags|draw string flags]].
  
 
== Return Value ==
 
== Return Value ==
Line 23: Line 30:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IUIX_Obj|IUIX_Obj]].
+
[[PXV:IUIX_Obj|IUIX_Obj]]

Latest revision as of 08:56, 26 May 2017


Calculates size in points for the given string.

Syntax

HRESULT CalcStringSize([in]                   LPWSTR      pString,
                       [in]                   LONG        nLength,
                       [in]                   IUIX_Font*  pFont,
                       [in, out]              SIZE*       pSize,
                       [in, defaultvalue(0)]  LONG        nFlags);

Parameters

pString
[in] Value of LPWSTR containing the string with text.
nLength
[in] Value of LONG containing the length of the string.
pFont
[in] Pointer to IUIX_Font containing a font that is being used.
pSize
[in, out] Pointer to SIZE containing the resulting string size.
nFlags
[in, defaultvalue(0)] Value of LONG containing the draw string flags.

Return Value

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

See Also

IUIX_Obj