IUIX_Inst::CreateFontFromHandle Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(12 intermediate revisions by 2 users not shown)
Line 2: Line 2:
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IUIX_Inst::CreateFontFromHandle Method}}
 
{{#customTitle:IUIX_Inst::CreateFontFromHandle Method}}
{{#parentPage:PXV:IUIX_Inst#Methods|CreateFontFromHandle Method|method}}
+
{{#parentPage:PXV:IUIX_Inst#Methods|CreateFontFromHandle|method}}
{{ToWrite}}
+
{{ToReview}}
+
  
The method of interface of PDF-XChange Editor SDK.
+
 
 +
Creates new object of [[PXV:IUIX_Font|IUIX_Font]] interface from other font <code>HANDLE_T</code> value.
  
 
== Syntax ==
 
== Syntax ==
Line 13: Line 12:
 
                             [in, defaultvalue(0)]    LONG        nFlags,
 
                             [in, defaultvalue(0)]    LONG        nFlags,
 
                             [in, defaultvalue(0)]    LONG        nFlagsMask,
 
                             [in, defaultvalue(0)]    LONG        nFlagsMask,
                             [out, retval]            IUIX_Font**  ppFont);</pre>
+
                             [out, retval]            IUIX_Font**  pFont);</pre>
  
 
== Parameters ==
 
== Parameters ==
 
;hFont
 
;hFont
:[in]  Value of HANDLE_T.
+
:[in]  <code>HANDLE_T</code> value of already existing font object.
 
;nNewFontSize
 
;nNewFontSize
:[in, defaultvalue(0.0)]  Value of double.
+
:[in, defaultvalue(0.0)]  specifies new size of a given font.
 
;nFlags
 
;nFlags
:[in, defaultvalue(0)]  Value of LONG.
+
:[in, defaultvalue(0)]  specifies font style with flags from [[PXV:UIX_CreateFontFlags|UIX_CreateFontFlags]] enumeration.
 
;nFlagsMask
 
;nFlagsMask
:[in, defaultvalue(0)]  Value of LONG.
+
:[in, defaultvalue(0)]  specifies style mask with flags from [[PXV:UIX_CreateFontFlags|UIX_CreateFontFlags]] enumeration. This parameter removes specified styles from current font and applies only those flags of '''nFlags''' parameter to the new font that were set in '''nFlagsMask'''. For instance, if previous font style was <code>UIX_CreateFont_Underline</code>, and new font style in '''nFlags''' parameter is set to <code>UIX_CreateFont_Bold</code> with '''nStyleMask''' parameter set to <code>(UIX_CreateFont_Bold | UIX_CreateFont_Underline)</code>, then a given font will be first set to ''non-underlined'', and then to ''bold''. If '''nStyleMask'''  is set to <code>UIX_ComboItemStyle_Bold</code>, then font style will be changed to ''bold'', but still remain ''underlined''.
;ppFont
+
;pFont
:[out, retval]  Pointer to [[PXV:IUIX_Font|IUIX_Font]].
+
:[out, retval]  return object of [[PXV:IUIX_Font|IUIX_Font]] interface.
  
 
== Return Value ==
 
== Return Value ==
Returns S_OK if operation was successful or error code in other cases.
+
Returns S_OK if the operation was successful, or will return an error code if it fails.  
  
 
== See Also ==
 
== See Also ==
[[PXV:IUIX_Inst|IUIX_Inst]].
+
[[PXV:IUIX_Inst|IUIX_Inst]]

Latest revision as of 17:30, 15 June 2015


Creates new object of IUIX_Font interface from other font HANDLE_T value.

Syntax

HRESULT CreateFontFromHandle([in]                     HANDLE_T     hFont,
                             [in, defaultvalue(0.0)]  double       nNewFontSize,
                             [in, defaultvalue(0)]    LONG         nFlags,
                             [in, defaultvalue(0)]    LONG         nFlagsMask,
                             [out, retval]            IUIX_Font**  pFont);

Parameters

hFont
[in] HANDLE_T value of already existing font object.
nNewFontSize
[in, defaultvalue(0.0)] specifies new size of a given font.
nFlags
[in, defaultvalue(0)] specifies font style with flags from UIX_CreateFontFlags enumeration.
nFlagsMask
[in, defaultvalue(0)] specifies style mask with flags from UIX_CreateFontFlags enumeration. This parameter removes specified styles from current font and applies only those flags of nFlags parameter to the new font that were set in nFlagsMask. For instance, if previous font style was UIX_CreateFont_Underline, and new font style in nFlags parameter is set to UIX_CreateFont_Bold with nStyleMask parameter set to (UIX_CreateFont_Bold | UIX_CreateFont_Underline), then a given font will be first set to non-underlined, and then to bold. If nStyleMask is set to UIX_ComboItemStyle_Bold, then font style will be changed to bold, but still remain underlined.
pFont
[out, retval] return object of IUIX_Font interface.

Return Value

Returns S_OK if the operation was successful, or will return an error code if it fails.

See Also

IUIX_Inst