New to Telerik Document Processing? Start a free 30-day trial

ThemableFontFamily

Class

Font family that can be taken from a theme (major/minor) or set locally and resolved at runtime.

Definition

Namespace:Telerik.Windows.Documents.Spreadsheet.Model

Assembly:Telerik.Windows.Documents.Core.dll

Syntax:

public class ThemableFontFamily : IThemableObject<FontFamily>

Inheritance: objectThemableFontFamily

Implements: IThemableObject<FontFamily>

Constructors

ThemableFontFamily(FontFamily)

Initializes a new instance of the ThemableFontFamily class with a concrete font family.

public ThemableFontFamily(FontFamily fontFamily)

Parameters:fontFamilyFontFamily

The font family.

ThemableFontFamily(string)

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

public ThemableFontFamily(string familyName)

Parameters:familyNamestring

Name of the family.

ThemableFontFamily(ThemeFontType)

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

public ThemableFontFamily(ThemeFontType themeFontType)

Parameters:themeFontTypeThemeFontType

Type of the theme font.

Methods

Equals(object)

bool

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

public override bool Equals(object obj)

Parameters:objobject

The object to compare with the current object.

Returns:

bool

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

Overrides: object.Equals(object)

FromFontFamily(FontFamily)

ThemableFontFamily

Convert a FontFamily to a ThemableFontFamily.

public static ThemableFontFamily FromFontFamily(FontFamily value)

Parameters:valueFontFamily

The FontFamily.

Returns:

ThemableFontFamily

The ThemableFontFamily.

GetActualValue(DocumentTheme)

FontFamily

Resolve the effective font family using the provided theme.

public FontFamily GetActualValue(DocumentTheme theme)

Parameters:themeDocumentTheme

The theme.

Returns:

FontFamily

The actual value.

Implements: IThemableObject<FontFamily>.GetActualValue(DocumentTheme)

GetHashCode()

int

Serves as a hash function for a particular type.

public override int GetHashCode()

Returns:

int

A hash code for the current object.

Overrides: object.GetHashCode()

ToString()

string

Returns a string that represents the current object.

public override string ToString()

Returns:

string

A string that represents the current object.

Overrides: object.ToString()

Operators

explicit operator ThemableFontFamily(FontFamily)

ThemableFontFamily

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

public static explicit operator ThemableFontFamily(FontFamily value)

Parameters:valueFontFamily

The font family.

Returns:

ThemableFontFamily

Themable font family.

operator !=(ThemableFontFamily, ThemableFontFamily)

bool

Compares two themable font families.

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

Parameters:firstThemableFontFamily

The first themable font family.

secondThemableFontFamily

The second themable font family.

Returns:

bool

If the two themable font families are not equal.

operator ==(ThemableFontFamily, ThemableFontFamily)

bool

Compares two themable font families.

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

Parameters:firstThemableFontFamily

The first themable font family.

secondThemableFontFamily

The second themable font family.

Returns:

bool

If the two themable font families are equal.

Properties

IsFromTheme

bool

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

public bool IsFromTheme { get; }

Property Value:

The value indicating if the instance is from a theme.

Implements: IThemableObject<FontFamily>.IsFromTheme

LocalValue

FontFamily

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

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.

public ThemeFontType ThemeFontType { get; }

Property Value:

The theme font type.