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

ThemeColorScheme

Class

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

Definition

Namespace:Telerik.Windows.Documents.Spreadsheet.Theming

Assembly:Telerik.Windows.Documents.Core.dll

Syntax:

[SuppressMessage("Microsoft.Naming", "CA1710:IdentifiersShouldHaveCorrectSuffix")]
public class ThemeColorScheme : NamedObjectBase, INamedObject, IEnumerable<ThemeColor>, IEnumerable

Inheritance: objectNamedObjectBaseThemeColorScheme

Implements: IEnumerableIEnumerable<ThemeColor>INamedObject

Inherited Members NamedObjectBase.Name

Constructors

ThemeColorScheme(string, Color, Color, Color, Color, Color, Color, Color, Color, Color, Color, Color, Color)

Initializes a new instance of the ThemeColorScheme class.

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:namestring

The name.

background1Color

The first background.

text1Color

The first text color.

background2Color

The second background.

text2Color

The second text color.

accent1Color

The first accent.

accent2Color

The second accent.

accent3Color

The third accent.

accent4Color

The fourth accent.

accent5Color

The fifth accent.

accent6Color

The sixth accent.

hyperlinkColor

The hyperlink color.

followedHyperlinkColor

The followed hyperlink color.

Methods

Clone()

ThemeColorScheme

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

public ThemeColorScheme Clone()

Returns:

ThemeColorScheme

The cloned theme color scheme.

Equals(object)

bool

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

public override bool Equals(object obj)

Parameters:objobject

The object to compare with the current color scheme.

Returns:

bool

True if the specified object is a ThemeColorScheme whose mapped theme colors match by category; otherwise, false.

Overrides: object.Equals(object)

GetEnumerator()

IEnumerator<ThemeColor>

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

public IEnumerator<ThemeColor> GetEnumerator()

Returns:

IEnumerator<ThemeColor>

An enumerator for the theme colors.

Implements: IEnumerable<ThemeColor>.GetEnumerator()

GetHashCode()

int

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

public override int GetHashCode()

Returns:

int

A hash code for the current color scheme.

Overrides: object.GetHashCode()

GetTintAndShade(ThemeColorType, ColorShadeType)

double

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

public double GetTintAndShade(ThemeColorType themeColorType, ColorShadeType colorShadeType)

Parameters:themeColorTypeThemeColorType

Type of the theme color.

colorShadeTypeColorShadeType

Type of the color shade.

Returns:

double

The tint and shade value.

Properties

this[ThemeColorType]

ThemeColor

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

public ThemeColor this[ThemeColorType colorType] { get; }

Parameters:colorTypeThemeColorTypeProperty Value:

The theme color.