IXRInline::GetFontFamily (Windows Embedded CE 6.0)

1/6/2010

This method retrieves the preferred top-level font family for the text in this inline element.

Syntax

virtual HRESULT STDMETHODCALLTYPE GetFontFamily(
    BSTR* pFontFamily
) = 0;

Parameters

• pFontFamily
  [out] Pointer to a string that describes the preferred top-level font family.

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.

To specify a specific font family in the pFontFamily string, that font must already be included in the OS design.

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 (,,).

The font family that you specify for an inline element must be included in the font file that you set for the text control in a previous call to IXRTextBlock::SetFontSource or IXRTextBox::SetFontSource.

.NET Framework Equivalent

System.Windows.Documents.Inline.FontFamily

Requirements

See Also

Reference

IXRInline
IXRInline::SetFontFamily