Class SpreadThemableColor

The color.

SpreadThemableColor(SpreadColor, bool)

Initializes a new instance of the SpreadThemableColor class.

Declaration

cs-api-definition

public SpreadThemableColor(SpreadColor color, bool isAutomatic)

Parameters

color

The color.

isAutomatic

The is automatic.

SpreadThemableColor(SpreadThemeColorType)

Initializes a new instance of the SpreadThemableColor class.

Declaration

cs-api-definition

public SpreadThemableColor(SpreadThemeColorType themeColorType)

Parameters

themeColorType

Type of the theme color.

SpreadThemableColor(SpreadThemeColorType, SpreadColorShadeType?)

Initializes a new instance of the SpreadThemableColor class.

Declaration

cs-api-definition

public SpreadThemableColor(SpreadThemeColorType themeColorType, SpreadColorShadeType? colorShadeType)

Parameters

themeColorType

Type of the theme color.

colorShadeType

SpreadColorShadeType?

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

SpreadThemableColor(SpreadThemeColorType, double)

Initializes a new instance of the SpreadThemableColor class.

Declaration

cs-api-definition

public SpreadThemableColor(SpreadThemeColorType themeColorType, double tintAndShade)

Parameters

themeColorType

Type of the theme color.

tintAndShade

double

The tint and shade.

Properties

ColorShadeType

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

Declaration

cs-api-definition

public SpreadColorShadeType? ColorShadeType { get; }

Property Value

SpreadColorShadeType?

The type of the color shade.

IsAutomatic

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

Declaration

cs-api-definition

public bool IsAutomatic { get; }

Property Value

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

cs-api-definition

public bool IsFromTheme { get; }

Property Value

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

cs-api-definition

public SpreadColor LocalValue { get; }

Property Value

The local value of the color.

ThemeColorType

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

Declaration

cs-api-definition

public SpreadThemeColorType ThemeColorType { get; }

Property Value

The type of the theme color.

TintAndShade

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

Declaration

cs-api-definition

public double? TintAndShade { get; }

Property Value

double?

The tint and shade value.

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

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

Overrides object.Equals(object)

FromRgb(byte, byte, byte)

Creates a new instance of the SpreadThemableColor class.

Declaration

cs-api-definition

public static SpreadThemableColor FromRgb(byte red, byte green, byte blue)

Parameters

red

byte

The red component.

green

byte

The green component.

blue

byte

The blue component.

Returns

Instance of the SpreadThemableColor class.

FromSpreadColor(SpreadColor)

Converts SpreadColor to SpreadThemableColor.

Declaration

cs-api-definition

public static SpreadThemableColor FromSpreadColor(SpreadColor value)

Parameters

value

The SpreadColor.

Returns

The SpreadThemableColor.

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 themable color.

Declaration

cs-api-definition

public override string ToString()

Returns

string

A string that represents the themable color.

Overrides object.ToString()

Operators

explicit operator SpreadThemableColor(SpreadColor)

Explicitly cast color to themable color.

Declaration

cs-api-definition

public static explicit operator SpreadThemableColor(SpreadColor value)

Parameters

value

The color.

Returns

Themable color.

operator !=(SpreadThemableColor, SpreadThemableColor)

Determines whether the specified themable colors are different.

Declaration

cs-api-definition

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

Parameters

first

second

Returns

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

operator ==(SpreadThemableColor, SpreadThemableColor)

Determines whether the specified themable colors are equal.

Declaration

cs-api-definition

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

Parameters

first

second

Returns