IDWriteFontFamily

関連するフォントのファミリーを表します。(IDWriteFontFamily)

フォントファミリーとは、"Times New Roman" のように同じファミリー名を共有しながらも、特徴が異なるフォントの集合です。こうした特徴の違いには、italic のようなスタイルや、bold のような太さ (weight) が含まれます。

次の図は、"Times New Roman" フォントファミリーに属するフォントの例を示しています。

IDWriteFontFamily* pFontFamily = NULL;

// Get the font family.
if (SUCCEEDED(hr))
{
    hr = pFontCollection->GetFontFamily(i, &pFontFamily);
}

フォントファミリー名は、テキストレイアウトオブジェクトやテキストフォーマットオブジェクトのフォントファミリーを指定するために使用されます。 IDWriteFontFamily::GetFamilyNames メソッドを使用すると、次のコードに示すように、IDWriteFontFamily オブジェクトからローカライズされたフォントファミリー名の一覧を IDWriteLocalizedStrings オブジェクトの形で取得できます。

IDWriteLocalizedStrings* pFamilyNames = NULL;

// Get a list of localized strings for the family name.
if (SUCCEEDED(hr))
{
    hr = pFontFamily->GetFamilyNames(&pFamilyNames);
}

フォントファミリーのファミリー名を、ロケール名をインデックスとして格納したローカライズ文字列オブジェクトを作成します。(IDWriteFontFamily.GetFamilyNames)

Type: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

次のコード例は、IDWriteFontFamily オブジェクトからフォントファミリー名を取得する方法を示しています。

IDWriteLocalizedStrings* pFamilyNames = NULL;

// Get a list of localized strings for the family name.
if (SUCCEEDED(hr))
{
    hr = pFontFamily->GetFamilyNames(&pFamilyNames);
}

UINT32 index = 0;
BOOL exists = false;

wchar_t localeName[LOCALE_NAME_MAX_LENGTH];

if (SUCCEEDED(hr))
{
    // Get the default locale for this user.
    int defaultLocaleSuccess = GetUserDefaultLocaleName(localeName, LOCALE_NAME_MAX_LENGTH);

    // If the default locale is returned, find that locale name, otherwise use "en-us".
    if (defaultLocaleSuccess)
    {
        hr = pFamilyNames->FindLocaleName(localeName, &index, &exists);
    }
    if (SUCCEEDED(hr) && !exists) // if the above find did not find a match, retry with US English
    {
        hr = pFamilyNames->FindLocaleName(L"en-us", &index, &exists);
    }
}

// If the specified locale doesn't exist, select the first on the list.
if (!exists)
    index = 0;

UINT32 length = 0;

// Get the string length.
if (SUCCEEDED(hr))
{
    hr = pFamilyNames->GetStringLength(index, &length);
}

// Allocate a string big enough to hold the name.
wchar_t* name = new (std::nothrow) wchar_t[length+1];
if (name == NULL)
{
    hr = E_OUTOFMEMORY;
}

// Get the family name.
if (SUCCEEDED(hr))
{
    hr = pFamilyNames->GetString(index, name, length+1);
}

指定したプロパティに最も一致するフォントを取得します。

Type: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

フォントファミリー内のフォントを、指定したプロパティにどれだけ一致するかの順にランク付けした一覧を取得します。

Type: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。