Class ThemableFontFamily

The font family.

ThemableFontFamily(ThemeFontType)

Initializes a new instance that references a theme font role (major/minor).

Declaration

cs-api-definition

public ThemableFontFamily(ThemeFontType themeFontType)

Parameters

themeFontType

ThemeFontType

Type of the theme font.

ThemableFontFamily(string)

Initializes a new instance of the ThemableFontFamily class from a family name.

Declaration

cs-api-definition

public ThemableFontFamily(string familyName)

Parameters

familyName

string

Name of the family.

Properties

IsFromTheme

Gets whether the font family is sourced from the theme rather than locally specified.

Declaration

cs-api-definition

public bool IsFromTheme { get; }

Property Value

The value indicating if the instance is from a theme.

Implements IThemableObject<FontFamily>.IsFromTheme

LocalValue

Gets the locally assigned font family when not resolved from the theme.

Declaration

cs-api-definition

public FontFamily LocalValue { get; }

Property Value

The local value.

Implements IThemableObject<FontFamily>.LocalValue

ThemeFontType

Gets the theme font role (major/minor) when the value originates from the theme.

Declaration

cs-api-definition

public ThemeFontType ThemeFontType { get; }

Property Value

ThemeFontType

The theme font type.

Methods

Equals(object)

Determines whether the specified object is equal to the current object.

Declaration

cs-api-definition

public override bool Equals(object obj)

Parameters

obj

object

The object to compare with the current object.

Returns

True if the specified object is equal to the current object; otherwise, false.

Overrides object.Equals(object)

FromFontFamily(FontFamily)

Convert a FontFamily to a ThemableFontFamily.

Declaration

cs-api-definition

public static ThemableFontFamily FromFontFamily(FontFamily value)

Parameters

value

The FontFamily.

Returns

The ThemableFontFamily.

GetActualValue(DocumentTheme)

Resolve the effective font family using the provided theme.

Declaration

cs-api-definition

public FontFamily GetActualValue(DocumentTheme theme)

Parameters

theme

DocumentTheme

The theme.

Returns

The actual value.

Implements IThemableObject<FontFamily>.GetActualValue(DocumentTheme)

GetHashCode()

Serves as a hash function for a particular type.

Declaration

cs-api-definition

public override int GetHashCode()

Returns

int

A hash code for the current object.

Overrides object.GetHashCode()

ToString()

Returns a string that represents the current object.

Declaration

cs-api-definition

public override string ToString()

Returns

string

A string that represents the current object.

Overrides object.ToString()

Operators

explicit operator ThemableFontFamily(FontFamily)

Explicitly cast a concrete font family to a themable font family.

Declaration

cs-api-definition

public static explicit operator ThemableFontFamily(FontFamily value)

Parameters

value

The font family.

Returns

Themable font family.

operator !=(ThemableFontFamily, ThemableFontFamily)

Compares two themable font families.

Declaration

cs-api-definition

public static bool operator !=(ThemableFontFamily first, ThemableFontFamily second)

Parameters

first

The first themable font family.

second

The second themable font family.

Returns

If the two themable font families are not equal.

operator ==(ThemableFontFamily, ThemableFontFamily)

Compares two themable font families.

Declaration

cs-api-definition

public static bool operator ==(ThemableFontFamily first, ThemableFontFamily second)

Parameters

first

The first themable font family.

second

The second themable font family.

Returns