Class SpreadThemableColor

Color value that may be a direct RGB color or a theme slot with optional shade/tint or automatic semantics.

Inheritance
System.Object
SpreadThemableColor
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.Documents.SpreadsheetStreaming
Assembly: Telerik.Documents.SpreadsheetStreaming.dll

Syntax

public class SpreadThemableColor

Constructors

SpreadThemableColor(SpreadColor)

Initializes a new instance of the SpreadThemableColor class.

Declaration
public SpreadThemableColor(SpreadColor color)
Parameters
SpreadColor color

The color.

SpreadThemableColor(SpreadColor, Boolean)

Initializes a new instance of the SpreadThemableColor class.

Declaration
public SpreadThemableColor(SpreadColor color, bool isAutomatic)
Parameters
SpreadColor color

The color.
System.Boolean isAutomatic

The is automatic.

SpreadThemableColor(SpreadThemeColorType)

Initializes a new instance of the SpreadThemableColor class.

Declaration
public SpreadThemableColor(SpreadThemeColorType themeColorType)
Parameters
SpreadThemeColorType themeColorType

Type of the theme color.

SpreadThemableColor(SpreadThemeColorType, Double)

Initializes a new instance of the SpreadThemableColor class.

Declaration
public SpreadThemableColor(SpreadThemeColorType themeColorType, double tintAndShade)
Parameters
SpreadThemeColorType themeColorType

Type of the theme color.
System.Double tintAndShade

The tint and shade.

SpreadThemableColor(SpreadThemeColorType, Nullable<SpreadColorShadeType>)

Initializes a new instance of the SpreadThemableColor class.

Declaration
public SpreadThemableColor(SpreadThemeColorType themeColorType, SpreadColorShadeType? colorShadeType)
Parameters
SpreadThemeColorType themeColorType

Type of the theme color.
System.Nullable<SpreadColorShadeType> colorShadeType

Type of the predefined tint and shade proportion for the themable color.

Properties

ColorShadeType

Predefined shade level applied to the theme color, if specified.

Declaration
public SpreadColorShadeType? ColorShadeType { get; }
Property Value
System.Nullable<SpreadColorShadeType>

The type of the color shade.

IsAutomatic

Indicates an automatic color whose final value may be chosen contextually by a consumer.

Declaration
public bool IsAutomatic { get; }
Property Value
System.Boolean

Value indicating if the color is automatic.

IsFromTheme

Indicates whether the color is derived from the workbook theme instead of a fixed RGB value.

Declaration
public bool IsFromTheme { get; }
Property Value
System.Boolean

The value indicating if the color comes from a theme.

LocalValue

Direct RGB color value when not theme-based; null if resolved from theme.

Declaration
public SpreadColor LocalValue { get; }
Property Value
SpreadColor

The local value of the color.

ThemeColorType

Theme color slot referenced when the color is theme-based.

Declaration
public SpreadThemeColorType ThemeColorType { get; }
Property Value
SpreadThemeColorType

The type of the theme color.

TintAndShade

Numeric tint/shade adjustment (-1..1) applied to the theme color to compute the final color.

Declaration
public double? TintAndShade { get; }
Property Value
System.Nullable<System.Double>

The tint and shade value.

Methods

Equals(Object)

Determines whether the specified System.Object is equal to the current System.Object.

Declaration
public override bool Equals(object obj)
Parameters
System.Object obj

The System.Object to compare with the current System.Object.
Returns
System.Boolean

Returns true if the specified System.Object is equal to the current System.Object; otherwise, false.
Overrides
System.Object.Equals(System.Object)

FromRgb(Byte, Byte, Byte)

Creates a new instance of the SpreadThemableColor class.

Declaration
public static SpreadThemableColor FromRgb(byte red, byte green, byte blue)
Parameters
System.Byte red

The red component.
System.Byte green

The green component.
System.Byte blue

The blue component.
Returns
SpreadThemableColor

Instance of the SpreadThemableColor class.

FromSpreadColor(SpreadColor)

Converts SpreadColor to SpreadThemableColor.

Declaration
public static SpreadThemableColor FromSpreadColor(SpreadColor value)
Parameters
SpreadColor value

The SpreadColor.
Returns
SpreadThemableColor

The SpreadThemableColor.

GetHashCode()

Serves as a hash function for a particular type.

Declaration
public override int GetHashCode()
Returns
System.Int32

A hash code for the current System.Object.
Overrides
System.Object.GetHashCode()

ToString()

Returns a string that represents the themable color.

Declaration
public override string ToString()
Returns
System.String

A string that represents the themable color.
Overrides
System.Object.ToString()

Operators

Equality(SpreadThemableColor, SpreadThemableColor)

Determines whether the specified themable colors are equal.

Declaration
public static bool operator ==(SpreadThemableColor first, SpreadThemableColor second)
Parameters
SpreadThemableColor first

SpreadThemableColor second

Returns
System.Boolean

True if the themable colors are equal; otherwise, false.

Explicit(SpreadColor to SpreadThemableColor)

Explicitly cast color to themable color.

Declaration
public static explicit operator SpreadThemableColor(SpreadColor value)
Parameters
SpreadColor value

The color.
Returns
SpreadThemableColor

Themable color.

Inequality(SpreadThemableColor, SpreadThemableColor)

Determines whether the specified themable colors are different.

Declaration
public static bool operator !=(SpreadThemableColor first, SpreadThemableColor second)
Parameters
SpreadThemableColor first

SpreadThemableColor second

Returns
System.Boolean

True if the themable colors are different; otherwise, false.