GrapeCity.Documents.Word.UserColor

Class UserColor

Namespace

GrapeCity.Documents.Word

Assembly

GcDocs.Word.dll

Represents an extended color.

public class UserColor

Inheritance

object

UserColor

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

UserColor(SolidColor)

Initializes a new instance of the UserColor class.

public UserColor(SolidColor color)

Parameters

color SolidColor

The SolidColor to copy properties from.

UserColor(ThemeColorId, float, float, float)

Initializes a new instance of the UserColor class.

public UserColor(ThemeColorId themeColor, float transparency, float brightness, float tintAndShade)

Parameters

themeColor ThemeColorId

A theme color that should be applied to the object.

transparency float

The degree of transparency of the color as a value between 0 (opaque) and 1 (clear).

brightness float

The brightness of the color from -1 (darkest) to 1 (lightest), zero being neutral.

tintAndShade float

The lightening or darkening of the color from -1 (darkest) to 1 (lightest), zero being neutral.

UserColor(ThemeColorId, float)

Initializes a new instance of the UserColor class.

public UserColor(ThemeColorId themeColor, float transparency)

Parameters

themeColor ThemeColorId

A theme color that should be applied to the object.

transparency float

The degree of transparency of the color as a value between 0 (opaque) and 1 (clear).

UserColor(ThemeColorId)

Initializes a new instance of the UserColor class.

public UserColor(ThemeColorId themeColor)

Parameters

themeColor ThemeColorId

a theme color that should be applied to the object.

UserColor(Color)

Initializes a new instance of the UserColor class.

public UserColor(Color color)

Parameters

color System.Drawing.Color

The Color to copy properties from.

Properties

Brightness

Gets the brightness of the color from -1 (darkest) to 1 (lightest), zero being neutral.

public float Brightness { get; }

Property Value

float

Color

Gets the RGB value of this color.

public Color Color { get; }

Property Value

System.Drawing.Color

ThemeColor

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

public ThemeColorId ThemeColor { get; }

Property Value

ThemeColorId

TintAndShade

Gets the lightening or darkening of the color from -1 (darkest) to 1 (lightest), zero being neutral.

public float TintAndShade { get; }

Property Value

float

Transparency

Gets the degree of transparency of the color as a value between 0 (opaque) and 1 (clear).

public float Transparency { get; }

Property Value

float