IUIX_Inst::CreateFontFromHandle Method

From PDF XChange PDF SDK
Jump to: navigation, search
Line 5: Line 5:
 
{{ToReview}}
 
{{ToReview}}
  
Creates new object of [[PXV:IUIX_Font|IUIX_Font]] interface from other font <code>HANDLE_T</code> value.
+
Creates new object of [[PXV:IUIX_Font|IUIX_Font]] interface from other font's <code>HANDLE_T</code> value.
  
 
== Syntax ==
 
== Syntax ==
Line 22: Line 22:
 
:[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
 
;nFlagsMask
:[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'''  had been set to <code>UIX_ComboItemStyle_Bold</code>, then font style would have been changed to ''bold'', but still remained ''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 '''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
 
;ppFont
 
:[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:25, 22 May 2015


Creates new object of IUIX_Font interface from other font's 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**  ppFont);

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.
ppFont
[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, IUIX_Font.