IUIX_Inst::CreateFontFromFont Method

From PDF XChange PDF SDK
Jump to: navigation, search
 
(5 intermediate revisions by one other user not shown)
Line 2: Line 2:
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IUIX_Inst::CreateFontFromFont Method}}
 
{{#customTitle:IUIX_Inst::CreateFontFromFont Method}}
{{#parentPage:PXV:IUIX_Inst#Methods|CreateFontFromFont Method|method}}
+
{{#parentPage:PXV:IUIX_Inst#Methods|CreateFontFromFont|method}}
{{ToReview}}
+
 
  
 
Creates new object of [[PXV:IUIX_Font|IUIX_Font]] interface from another [[PXV:IUIX_Font|IUIX_Font]] object.
 
Creates new object of [[PXV:IUIX_Font|IUIX_Font]] interface from another [[PXV:IUIX_Font|IUIX_Font]] object.
Line 12: 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 ==
Line 23: Line 23:
 
;nFlagsMask
 
;nFlagsMask
 
:[in, defaultvalue(0)]  specifies style mask with flags from [[PXV:UIX_CreateFontFlags|UIX_CreateFontFlags]] enumeration. This parameter removes specified styles from previous 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  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 remain ''underlined''.
 
:[in, defaultvalue(0)]  specifies style mask with flags from [[PXV:UIX_CreateFontFlags|UIX_CreateFontFlags]] enumeration. This parameter removes specified styles from previous 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  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 remain ''underlined''.
;ppFont
+
;pFont
 
:[out, retval]  return object of [[PXV:IUIX_Font|IUIX_Font]] interface.
 
:[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_Font|IUIX_Font]].
+
[[PXV:IUIX_Inst|IUIX_Inst]]

Latest revision as of 17:29, 15 June 2015


Creates new object of IUIX_Font interface from another IUIX_Font object.

Syntax

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

Parameters

pSrcFont
[in] source font object of IUIX_Font interface.
nNewFontSize
[in, defaultvalue(0.0)] specifies new font size.
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 previous 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 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 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