IXRControl::GetFontFamily (Compact 2013)
3/28/2014
This method retrieves the font that is used to display text in this control.
Syntax
virtual HRESULT STDMETHODCALLTYPE GetFontFamily(
BSTR* pFontFamily
) = 0;
Parameters
- pFontFamily
[out] Pointer to a string that describes the preferred top-level font family that is used to display text in this control.
Return Value
Returns an HRESULT that indicates success or failure.
Remarks
A font family is a set of typefaces that share the same family name, such as "Times New Roman," yet differ in features. These feature differences typically include font style, such as italic, and font weight, such as bold.
If you set a font (either in XAML or C++) that is not supported, XAML for Windows Embedded will attempt to instead use a fallback font, and if none is supported, it will use the default composite font. XAML for Windows Embedded uses the default fallback font family "Windows Embedded Compact User Interface" as the composite font. This font is defined as a composite font, whose file name is "WindowsEmbeddedCompactUserInterface.CompositeFont". Also note that if you want to set a font using the pFontFamily string or use the font fallback feature for that font, you must include the catalog item for that font in the OS design. For more information, see Fonts Catalog Items and Sysgen Variables.
When multiple families are specified, the second and successive font families serve as fallback families to use if the primary font family is unavailable or not applicable. To specify multiple font families, use the following syntax:
fontFamilyName[,fallbackFontFamilyName]
In this syntax, fontFamilyName specifies the primary font, and fallbackFontFamilyName specifies an optional fallback. More than one fallback can be specified. Use commas to separate each font family string. To avoid ambiguity, if a font family contains a comma (,) in the name, each single comma in a font family reference must be replaced with a double comma (,,).
Make sure that you also use IXRControl::SetFontStretch, IXRControl::SetFontStyle, and IXRControl::SetFontWeight for displaying the font consistently in this control.
Note
Most font files are licensed instead of sold, and licenses that govern the use of fonts vary from vendor to vendor. It is your responsibility to make sure that you have the required license rights for any font that you embed in an application, or that you otherwise redistribute.
.NET Framework Equivalent
System.Windows.Controls.Control.FontFamily
Requirements
Header |
XamlRuntime.h |
sysgen |
SYSGEN_XAML_RUNTIME |