Class ThemeColorScheme

Defines the mapping from theme color categories to concrete colors and exposes shade/tint helpers.

Inheritance
System.Object
NamedObjectBase
ThemeColorScheme
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.Windows.Documents.Spreadsheet.Theming
Assembly: Telerik.Windows.Documents.Core.dll

Syntax

public class ThemeColorScheme : NamedObjectBase, INamedObject, IEnumerable<ThemeColor>, IEnumerable

Constructors

ThemeColorScheme(String, Color, Color, Color, Color, Color, Color, Color, Color, Color, Color, Color, Color)

Initializes a new instance of the ThemeColorScheme class.

Declaration
public ThemeColorScheme(string name, Color background1, Color text1, Color background2, Color text2, Color accent1, Color accent2, Color accent3, Color accent4, Color accent5, Color accent6, Color hyperlink, Color followedHyperlink)
Parameters
System.String name

The name.
System.Windows.Media.Color background1

The first background.
System.Windows.Media.Color text1

The first text color.
System.Windows.Media.Color background2

The second background.
System.Windows.Media.Color text2

The second text color.
System.Windows.Media.Color accent1

The first accent.
System.Windows.Media.Color accent2

The second accent.
System.Windows.Media.Color accent3

The third accent.
System.Windows.Media.Color accent4

The fourth accent.
System.Windows.Media.Color accent5

The fifth accent.
System.Windows.Media.Color accent6

The sixth accent.
System.Windows.Media.Color hyperlink

The hyperlink color.
System.Windows.Media.Color followedHyperlink

The followed hyperlink color.

Properties

Item[ThemeColorType]

Gets the ThemeColor with the specified color type. Returns the theme color mapped for that category.

Declaration
public ThemeColor this[ThemeColorType colorType] { get; }
Parameters
ThemeColorType colorType

Property Value
ThemeColor

The theme color.

Methods

Clone()

Create a deep copy of the color scheme, duplicating all color mappings.

Declaration
public ThemeColorScheme Clone()
Returns
ThemeColorScheme

The cloned theme color scheme.

Equals(Object)

Determines whether the specified object is equal to this color scheme.

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

The object to compare with the current color scheme.
Returns
System.Boolean

True if the specified object is a ThemeColorScheme whose mapped theme colors match by category; otherwise, false.
Overrides
System.Object.Equals(System.Object)

GetEnumerator()

Returns an enumerator that iterates through the theme colors in this scheme.

Declaration
public IEnumerator<ThemeColor> GetEnumerator()
Returns
System.Collections.Generic.IEnumerator<ThemeColor>

An enumerator for the theme colors.
Implements
System.Collections.Generic.IEnumerable<T>.GetEnumerator()

GetHashCode()

Returns a hash code for this color scheme based on its color mappings.

Declaration
public override int GetHashCode()
Returns
System.Int32

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

GetTintAndShade(ThemeColorType, ColorShadeType)

Compute the tint/shade adjustment for a given theme color and shade step.

Declaration
public double GetTintAndShade(ThemeColorType themeColorType, ColorShadeType colorShadeType)
Parameters
ThemeColorType themeColorType

Type of the theme color.
ColorShadeType colorShadeType

Type of the color shade.
Returns
System.Double

The tint and shade value.

Explicit Interface Implementations

IEnumerable.GetEnumerator()

Declaration
IEnumerator IEnumerable.GetEnumerator()
Returns
System.Collections.IEnumerator

Implements
System.Collections.IEnumerable.GetEnumerator()

Extension Methods