Class DWriteFont

The IDWriteFont interface represents a physical font in a font collection.

Inheritance

object

DWriteFont

Implements

IDisposable

IDWriteReleasable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: JeremyAnsel.DirectX.DWrite

Assembly: JeremyAnsel.DirectX.DWrite.dll

Syntax

public sealed class DWriteFont : IDisposable, IDWriteReleasable

Properties

| Edit this page View Source

Handle

Gets an handle representing the DWrite object interface.

Declaration

public object Handle { get; }

Property Value

Type	Description
object

| Edit this page View Source

IsSymbolFont

Gets a value indicating whether the font is a symbol font.

Declaration

public bool IsSymbolFont { get; }

Property Value

Type	Description
bool

| Edit this page View Source

Simulations

Gets a value that indicates what simulation are applied to the specified font.

Declaration

public DWriteFontSimulations Simulations { get; }

Property Value

Type	Description
DWriteFontSimulations

| Edit this page View Source

Stretch

Gets the stretch (aka. width) of the specified font.

Declaration

public DWriteFontStretch Stretch { get; }

Property Value

Type	Description
DWriteFontStretch

| Edit this page View Source

Style

Gets the style (aka. slope) of the specified font.

Declaration

public DWriteFontStyle Style { get; }

Property Value

Type	Description
DWriteFontStyle

| Edit this page View Source

Weight

Gets the weight of the specified font.

Declaration

public DWriteFontWeight Weight { get; }

Property Value

Type	Description
DWriteFontWeight

Methods

| Edit this page View Source

CreateFontFace()

Creates a font face object for the font.

Declaration

public DWriteFontFace CreateFontFace()

Returns

Type	Description
DWriteFontFace	DWriteFontFace

| Edit this page View Source

Dispose()

Immediately releases the unmanaged resources used by the DWrite object.

Declaration

public void Dispose()

| Edit this page View Source

GetFaceNames()

Gets a localized strings collection containing the face names for the font (e.g., Regular or Bold), indexed by locale name.

Declaration

public DWriteLocalizedStrings GetFaceNames()

Returns

Type	Description
DWriteLocalizedStrings	DWriteLocalizedStrings

| Edit this page View Source

GetFontFamily()

Gets the font family to which the specified font belongs.

Declaration

public DWriteFontFamily GetFontFamily()

Returns

Type	Description
DWriteFontFamily	DWriteFontFamily

| Edit this page View Source

GetInformationalStrings(DWriteInformationalStringId)

Gets a localized strings collection containing the specified informational strings, indexed by locale name.

Declaration

public DWriteLocalizedStrings GetInformationalStrings(DWriteInformationalStringId informationalStringId)

Parameters

Type	Name	Description
DWriteInformationalStringId	informationalStringId	Identifies the string to get.

Returns

Type	Description
DWriteLocalizedStrings	DWriteLocalizedStrings

Remarks

If the font does not contain the specified string, the return value is S_OK but informationalStrings receives a NULL pointer and exists receives the value FALSE.

| Edit this page View Source

GetMetrics()

Gets the metrics for the font.

Declaration

public DWriteFontMetrics GetMetrics()

Returns

Type	Description
DWriteFontMetrics	DWriteFontMetrics

| Edit this page View Source

HasCharacter(uint)

Determines whether the font supports the specified character.

Declaration

public bool HasCharacter(uint unicodeValue)

Parameters

Type	Name	Description
uint	unicodeValue	Unicode (UCS-4) character value.

Returns

Type	Description
bool	bool

| Edit this page View Source

Release()

Releases the managed reference to the COM DWrite interface.

Declaration

public void Release()

| Edit this page View Source

ToBoolean()

Gets a boolean indicating if the handle is not null.

Declaration

public bool ToBoolean()

Returns

Type	Description
bool	A boolean

Operators

| Edit this page View Source

implicit operator bool(DWriteFont)

Gets a boolean indicating if the handle is not null.

Declaration

public static implicit operator bool(DWriteFont value)

Parameters

Type	Name	Description
DWriteFont	value	A DWrite object.

Returns

Type	Description
bool	A boolean

Implements

IDisposable

IDWriteReleasable