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

ThemableColor

Class

Color value that can originate from a theme or a local override and be resolved to an actual color.

Definition

Namespace:Telerik.Windows.Documents.Spreadsheet.Model

Assembly:Telerik.Windows.Documents.Core.dll

Syntax:

[TypeConverter(typeof(ThemableColorTypeConverter))]
public class ThemableColor : IThemableObject<Color>

Inheritance: objectThemableColor

Implements: IThemableObject<Color>

Constructors

ThemableColor(Color, bool)

Initializes a new instance of the ThemableColor class with a concrete color and an automatic flag.

public ThemableColor(Color color, bool isAutomatic)

Parameters:colorColor

The color.

isAutomaticbool

The is automatic.

ThemableColor(Color)

Initializes a new instance of the ThemableColor class with a concrete color value.

public ThemableColor(Color color)

Parameters:colorColor

The color.

ThemableColor(ThemeColorType, ColorShadeType?)

Initializes a new instance that references a theme color and optional shade step.

public ThemableColor(ThemeColorType themeColorType, ColorShadeType? colorShadeType = null)

Parameters:themeColorTypeThemeColorType

The theme color type.

colorShadeTypeColorShadeType?

The color shade type.

ThemableColor(ThemeColorType, double)

Initializes a new instance that references a theme color with a tint/shade adjustment in [-1, 1].

public ThemableColor(ThemeColorType themeColorType, double tintAndShade)

Parameters:themeColorTypeThemeColorType

Theme color type.

tintAndShadedouble

The tint and shade.

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)

FromArgb(byte, byte, byte, byte)

ThemableColor

Create a themable color from ARGB components.

public static ThemableColor FromArgb(byte alfa, byte red, byte green, byte blue)

Parameters:alfabyte

The alfa 0 to 255.

redbyte

The red 0 to 255.

greenbyte

The green 0 to 255.

bluebyte

The blue 0 to 255.

Returns:

ThemableColor

FromColor(Color)

ThemableColor

Convert a Color to a ThemableColor.

public static ThemableColor FromColor(Color value)

Parameters:valueColor

The Color.

Returns:

ThemableColor

The ThemableColor.

GetActualValue(DocumentTheme)

Color

Resolve the effective color using the specified theme.

public Color GetActualValue(DocumentTheme theme)

Parameters:themeDocumentTheme

The theme.

Returns:

Color

The actual value.

Implements: IThemableObject<Color>.GetActualValue(DocumentTheme)

GetActualValue(ThemeColorScheme)

Color

Resolve the effective color using the provided color scheme.

public Color GetActualValue(ThemeColorScheme colorScheme)

Parameters:colorSchemeThemeColorScheme

The color scheme.

Returns:

Color

The actual color.

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 ThemableColor(Color)

ThemableColor

Explicitly cast a concrete color to a themable color instance.

public static explicit operator ThemableColor(Color value)

Parameters:valueColor

The color.

Returns:

ThemableColor

Themable color.

operator !=(ThemableColor, ThemableColor)

bool

Compare two themable colors for inequality.

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

Parameters:firstThemableColor

The first themable color.

secondThemableColor

The second themable color.

Returns:

bool

If the two themable colors are equal.

operator ==(ThemableColor, ThemableColor)

bool

Compare two themable colors for value equality.

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

Parameters:firstThemableColor

The first themable color.

secondThemableColor

The second themable color.

Returns:

bool

If the two themable colors are equal.

Properties

ColorShadeType

ColorShadeType?

Gets the shade step used to derive a lighter/darker variant when the color references a theme.

public ColorShadeType? ColorShadeType { get; }

Property Value:

The color shade type.

IsAutomatic

bool

Gets whether the color is marked as automatic, allowing consumers to adjust it as appropriate.

public bool IsAutomatic { get; }

Property Value:

Value indicating if the color is automatic.

IsFromTheme

bool

Gets whether the color is resolved from the theme rather than a local color.

public bool IsFromTheme { get; }

Property Value:

The value indicating if the instance is from a theme.

Implements: IThemableObject<Color>.IsFromTheme

LocalValue

Color

Gets the locally assigned color used when the value does not come from the theme.

public Color LocalValue { get; }

Implements: IThemableObject<Color>.LocalValue

ThemeColorType

Gets the referenced theme color type when the value comes from the theme.

public ThemeColorType ThemeColorType { get; }

Property Value:

The theme color type.

TintAndShade

double?

Gets the tint/shade adjustment in the range [-1, 1] when explicitly specified.

public double? TintAndShade { get; }

Property Value:

The tint and shade.