IUIX_Inst::CreateFontFromFont Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 3: Line 3:
 
{{#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|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Creates new object of [[PXV:IUIX_Font|IUIX_Font]] interface from another [[PXV:IUIX_Font|IUIX_Font]] object.
  
 
== Syntax ==
 
== Syntax ==
Line 17: Line 16:
 
== Parameters ==
 
== Parameters ==
 
;pSrcFont
 
;pSrcFont
:[in]  Pointer to [[PXV:IUIX_Font|IUIX_Font]].
+
:[in]  source ''font'' object of [[PXV:IUIX_Font|IUIX_Font]] interface.
 
;nNewFontSize
 
;nNewFontSize
:[in, defaultvalue(0.0)]  Value of double.
+
:[in, defaultvalue(0.0)]  specifies new font size.
 
;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'''  had been set to <code>UIX_ComboItemStyle_Bold</code>, then font style would have been changed to ''bold'', but still remained ''underlined''.
 
;ppFont
 
;ppFont
:[out, retval]  Pointer to [[PXV:IUIX_Font|IUIX_Font]].
+
:[out, retval]  return object of [[PXV:IUIX_Font|IUIX_Font]] interface.
  
 
== Return Value ==
 
== Return Value ==
Line 31: Line 30:
  
 
== See Also ==
 
== See Also ==
[[PXV:IUIX_Inst|IUIX_Inst]].
+
[[PXV:IUIX_Inst|IUIX_Inst]], [[PXV:IUIX_Font|IUIX_Font]].

Revision as of 07:22, 22 May 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**  ppFont);

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 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 had been set to UIX_ComboItemStyle_Bold, then font style would have been changed to bold, but still remained 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.