IUIX_Inst::CreateFontFromHandle Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
Line 8: Line 8:
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT CreateFontFromHandle([in]                    HANDLE_T    nFont,
+
<pre class="brush:cpp;gutter:false">HRESULT CreateFontFromHandle([in]                    HANDLE_T    HFont,
                             [in, defaultvalue(0.0)]  double      nNewFontSize,
+
                             [in, defaultvalue(0.0)]  double      NewFontSize,
                             [in, defaultvalue(0)]    LONG        nFlags,
+
                             [in, defaultvalue(0)]    LONG        Flags,
                             [in, defaultvalue(0)]    LONG        nFlagsMask,
+
                             [in, defaultvalue(0)]    LONG        FlagsMask,
                             [out, retval]            IUIX_Font**  pFont);</pre>
+
                             [out, retval]            IUIX_Font**  Font);</pre>
  
 
== Parameters ==
 
== Parameters ==
;nFont
+
;HFont
 
:[in]  <code>HANDLE_T</code> value of already existing font object.
 
:[in]  <code>HANDLE_T</code> value of already existing font object.
;nNewFontSize
+
;NewFontSize
 
:[in, defaultvalue(0.0)]  specifies new size of a given font.
 
:[in, defaultvalue(0.0)]  specifies new size of a given font.
;nFlags
+
;Flags
 
:[in, defaultvalue(0)]  specifies font style with flags from [[PXV:UIX_CreateFontFlags|UIX_CreateFontFlags]] enumeration.
 
:[in, defaultvalue(0)]  specifies font style with flags from [[PXV:UIX_CreateFontFlags|UIX_CreateFontFlags]] enumeration.
;nFlagsMask
+
;FlagsMask
:[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''.
+
:[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 '''Flags''' parameter to the new font that were set in '''FlagsMask'''. For instance, if previous font style was <code>UIX_CreateFont_Underline</code>, and new font style in '''Flags''' 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''.
;pFont
+
;Font
 
:[out, retval]  return object of [[PXV:IUIX_Font|IUIX_Font]] interface.
 
:[out, retval]  return object of [[PXV:IUIX_Font|IUIX_Font]] interface.
  

Revision as of 07:50, 12 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       NewFontSize,
                             [in, defaultvalue(0)]    LONG         Flags,
                             [in, defaultvalue(0)]    LONG         FlagsMask,
                             [out, retval]            IUIX_Font**  Font);

Parameters

HFont
[in] HANDLE_T value of already existing font object.
NewFontSize
[in, defaultvalue(0.0)] specifies new size of a given font.
Flags
[in, defaultvalue(0)] specifies font style with flags from UIX_CreateFontFlags enumeration.
FlagsMask
[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 Flags parameter to the new font that were set in FlagsMask. For instance, if previous font style was UIX_CreateFont_Underline, and new font style in Flags 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.
Font
[out, retval] return object of IUIX_Font interface.

Return Value

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

See Also

IUIX_Inst