GrapeCity.Documents.Word.WordColor

Class WordColor

Namespace

GrapeCity.Documents.Word

Assembly

GcDocs.Word.dll

Represents the color of a one-color object or the foreground or background color of an object with a gradient or patterned fill. You can set colors to an explicit red-green-blue value by using the RGB property.

public class WordColor : FormattingBag

Inheritance

object

FormattingBag

WordColor

Inherited Members

FormattingBag.KeyDelimiter

FormattingBag.KeyFormat

FormattingBag.GetFormattingKey(string)

FormattingBag.GetShortKey(string)

FormattingBag.GetChildKeyPart(string)

FormattingBag.ConcateKeys(string, string)

FormattingBag.ConcateKeys(string[], string)

FormattingBag.ConcateKeys(string, string[])

FormattingBag.GetFormatting<T>(string, T)

FormattingBag.GetFormatting<T>(string, T, out int, bool)

FormattingBag.GetPropertyFormatting<T>(T, string)

FormattingBag.SetFormatting(string, object, bool)

FormattingBag.UpdateVersion(int?)

FormattingBag.SetPropertyFormatting(object, string)

FormattingBag.SetFormatting<T>(string, object, T, bool)

FormattingBag.SetPropertyFormattingEx<T>(object, T, string)

FormattingBag.GetDirectFormatting<T>(string, T)

FormattingBag.TryGetDirectFormatting<T>(string, T, out T, bool)

FormattingBag.GetDirectPropertyFormatting<T>(T, string)

FormattingBag.SetDirectPropertyFormatting(object, string)

FormattingBag.SetDirectPropertyFormattingEx<T>(object, T, string)

FormattingBag.RemoveDirectFormatting(string)

FormattingBag.HasDirectFormatting(string)

FormattingBag.HasDirectPropertyFormatting(string)

FormattingBag.HasDirectFormatting(string, string)

FormattingBag.HasDirectFormattingWithIgnore(string, string)

FormattingBag.HasDirectFormattingWithIgnore(string, string, string)

FormattingBag.BaseKey

FormattingBag.ParentKey

FormattingBag.RootKey

FormattingBag.SyncBaseKeys

object.ToString()

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

object.MemberwiseClone()

Properties

RGB

Gets or sets the RGB color value. The System.Drawing.Color.Empty value indicates auto color. Only solid colors (with alpha 255) are supported.

If this property is set to a value other than System.Drawing.Color.Empty, ThemeColor, ThemeShade and ThemeTint property values are removed.

public Color RGB { get; set; }

Property Value

System.Drawing.Color

ThemeColor

Gets or sets a theme color that should be applied to the current object.

public ThemeColorId ThemeColor { get; set; }

Property Value

ThemeColorId

Remarks

The specified theme color is a reference to one of the predefined theme colors, located in the document themes, which allows for color information to be set centrally in the document.

ThemeShade

Gets or sets the shade value applied to the supplied theme color (if any) for this contents.

public byte ThemeShade { get; set; }

Property Value

byte

Remarks

If the ThemeShade is supplied, then it is applied to the RGB value of the theme color to determine the final color applied to this contents.

ThemeTint

Gets or sets the tint value applied to the supplied theme color (if any) for this contents.

public byte ThemeTint { get; set; }

Property Value

byte

Remarks

If the ThemeTint is supplied, then it is applied to the RGB value of the theme color to determine the final color applied to this contents.

Methods

ClearFormatting()

Resets to default color formatting.

public override void ClearFormatting()

Remarks

Removes all font formatting specified explicitly on the object from which Color was obtained so the color formatting will be inherited from the appropriate parent.

Equals(WordColor)

protected bool Equals(WordColor other)

Parameters

other WordColor

Returns

bool

Equals(object)

public override bool Equals(object obj)

Parameters

obj object

Returns

bool

FixInheritedValues()

Fixes all inherited values as "direct" values for this instance.

protected override void FixInheritedValues()

GetHashCode()

public override int GetHashCode()

Returns

int