ClassThemableColor
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:
Constructors
ThemableColor(Color)
Initializes a new instance of the ThemableColor class with a concrete color value.
Declaration
public ThemableColor(Color color)Parameters
color
Color
The color.
ThemableColor(Color, bool)
Initializes a new instance of the ThemableColor class with a concrete color and an automatic flag.
Declaration
public ThemableColor(Color color, bool isAutomatic)Parameters
color
Color
The color.
isAutomatic
The is automatic.
ThemableColor(ThemeColorType, ColorShadeType?)
Initializes a new instance that references a theme color and optional shade step.
Declaration
public ThemableColor(ThemeColorType themeColorType, ColorShadeType? colorShadeType = null)Parameters
themeColorType
The theme color type.
colorShadeType
The color shade type.
ThemableColor(ThemeColorType, double)
Initializes a new instance that references a theme color with a tint/shade adjustment in [-1, 1].
Declaration
public ThemableColor(ThemeColorType themeColorType, double tintAndShade)Parameters
themeColorType
Theme color type.
tintAndShade
The tint and shade.
Properties
ColorShadeType
Gets the shade step used to derive a lighter/darker variant when the color references a theme.
Declaration
public ColorShadeType? ColorShadeType { get; }Property Value
The color shade type.
IsAutomatic
Gets whether the color is marked as automatic, allowing consumers to adjust it as appropriate.
Declaration
public bool IsAutomatic { get; }Property Value
Value indicating if the color is automatic.
IsFromTheme
Gets whether the color is resolved from the theme rather than a local color.
Declaration
public bool IsFromTheme { get; }Property Value
The value indicating if the instance is from a theme.
Implements
LocalValue
Gets the locally assigned color used when the value does not come from the theme.
Declaration
public Color LocalValue { get; }Property Value
Color
Implements
ThemeColorType
Gets the referenced theme color type when the value comes from the theme.
Declaration
public ThemeColorType ThemeColorType { get; }Property Value
The theme color type.
TintAndShade
Gets the tint/shade adjustment in the range [-1, 1] when explicitly specified.
Declaration
public double? TintAndShade { get; }Property Value
The tint and shade.
Methods
FromArgb(byte, byte, byte, byte)
Create a themable color from ARGB components.
Declaration
public static ThemableColor FromArgb(byte alfa, byte red, byte green, byte blue)Parameters
alfa
The alfa 0 to 255.
red
The red 0 to 255.
green
The green 0 to 255.
blue
The blue 0 to 255.
Returns
FromColor(Color)
Convert a Color to a ThemableColor.
Declaration
public static ThemableColor FromColor(Color value)Parameters
value
Color
The Color.
Returns
The ThemableColor.
GetActualValue(DocumentTheme)
Resolve the effective color using the specified theme.
Declaration
public Color GetActualValue(DocumentTheme theme)Parameters
theme
The theme.
Returns
Color
The actual value.
Implements
GetActualValue(ThemeColorScheme)
Resolve the effective color using the provided color scheme.
Declaration
public Color GetActualValue(ThemeColorScheme colorScheme)Parameters
colorScheme
The color scheme.
Returns
Color
The actual color.
GetHashCode()
Serves as a hash function for a particular type.
Operators
explicit operator ThemableColor(Color)
Explicitly cast a concrete color to a themable color instance.
Declaration
public static explicit operator ThemableColor(Color value)Parameters
value
Color
The color.
Returns
Themable color.
operator !=(ThemableColor, ThemableColor)
Compare two themable colors for inequality.
Declaration
public static bool operator !=(ThemableColor first, ThemableColor second)Parameters
first
The first themable color.
second
The second themable color.
Returns
If the two themable colors are equal.
operator ==(ThemableColor, ThemableColor)
Compare two themable colors for value equality.
Declaration
public static bool operator ==(ThemableColor first, ThemableColor second)Parameters
first
The first themable color.
second
The second themable color.
Returns
If the two themable colors are equal.