Color Struct

Namespace:
GemBox.Document
Assembly:
GemBox.Document.dll

Represents a color.

public struct Color : IEquatable<Color>
Public Structure Color
    Implements IEquatable(Of Color)
Implements
System.IEquatable<Color>

Constructors

Color(Byte, Byte, Byte)

Initializes a new instance of the Color struct.

public Color(byte red, byte green, byte blue)
Public Sub New(red As Byte, green As Byte, blue As Byte)
Parameters
red
System.Byte

The red component.

green
System.Byte

The green component.

blue
System.Byte

The blue component.

Color(Int32)

Initializes a new instance of the Color struct.

public Color(int hex)
Public Sub New(hex As Integer)
Parameters
hex
System.Int32

The integer that represents the color in the format [__,RR,GG,BB] where RR is the byte that represents the red component, GG is the byte that represents the green component and BB is the byte that represents the blue component.

Fields

Black

Represents a black color (RGB = 0x000000).

public static readonly Color Black
Public Shared ReadOnly Black As Color
Field Value
Color

Blue

Represents a blue color (RGB = 0x0000FF).

public static readonly Color Blue
Public Shared ReadOnly Blue As Color
Field Value
Color

Brown

Represents a brown color (RGB = 0xA52A2A).

public static readonly Color Brown
Public Shared ReadOnly Brown As Color
Field Value
Color

Cyan

Represents a cyan color (RGB = 0x00FFFF).

public static readonly Color Cyan
Public Shared ReadOnly Cyan As Color
Field Value
Color

DarkBlue

Represents a dark blue color (RGB = 0x000080).

public static readonly Color DarkBlue
Public Shared ReadOnly DarkBlue As Color
Field Value
Color

DarkCyan

Represents a dark cyan color (RGB = 0x008080).

public static readonly Color DarkCyan
Public Shared ReadOnly DarkCyan As Color
Field Value
Color

DarkGray

Represents a dark gray color (RGB = 0x808080).

public static readonly Color DarkGray
Public Shared ReadOnly DarkGray As Color
Field Value
Color

DarkGreen

Represents a dark green color (RGB = 0x008000).

public static readonly Color DarkGreen
Public Shared ReadOnly DarkGreen As Color
Field Value
Color

DarkMagenta

Represents a dark magenta color (RGB = 0x800080).

public static readonly Color DarkMagenta
Public Shared ReadOnly DarkMagenta As Color
Field Value
Color

DarkRed

Represents a dark red color (RGB = 0x800000).

public static readonly Color DarkRed
Public Shared ReadOnly DarkRed As Color
Field Value
Color

DarkYellow

Represents a dark yellow color (RGB = 0x808000).

public static readonly Color DarkYellow
Public Shared ReadOnly DarkYellow As Color
Field Value
Color

Empty

Represents an empty color (RGB = 0x000000).

public static readonly Color Empty
Public Shared ReadOnly Empty As Color
Field Value
Color

Gray

Represents a gray color (RGB = 0x808080).

public static readonly Color Gray
Public Shared ReadOnly Gray As Color
Field Value
Color

Green

Represents a green color (RGB = 0x00FF00).

public static readonly Color Green
Public Shared ReadOnly Green As Color
Field Value
Color

LightGray

Represents a light gray color (RGB = 0xC0C0C0).

public static readonly Color LightGray
Public Shared ReadOnly LightGray As Color
Field Value
Color

Magenta

Represents a magenta color (RGB = 0xFF00FF).

public static readonly Color Magenta
Public Shared ReadOnly Magenta As Color
Field Value
Color

Orange

Represents an orange color (RGB = 0xFFA500).

public static readonly Color Orange
Public Shared ReadOnly Orange As Color
Field Value
Color

Pink

Represents a pink color (RGB = 0xFFC0CB).

public static readonly Color Pink
Public Shared ReadOnly Pink As Color
Field Value
Color

Purple

Represents a purple color (RGB = 0x800080).

public static readonly Color Purple
Public Shared ReadOnly Purple As Color
Field Value
Color

Red

Represents a red color (RGB = 0xFF0000).

public static readonly Color Red
Public Shared ReadOnly Red As Color
Field Value
Color

White

Represents a write color (RGB = 0xFFFFFF).

public static readonly Color White
Public Shared ReadOnly White As Color
Field Value
Color

Yellow

Represents a yellow color (RGB = 0xFFFF00).

public static readonly Color Yellow
Public Shared ReadOnly Yellow As Color
Field Value
Color

Properties

B

Gets the blue component of this Color instance.

public readonly byte B { get; }
Public ReadOnly Property B As Byte
Property Value
System.Byte

The blue component of this Color instance.

G

Gets the green component of this Color instance.

public readonly byte G { get; }
Public ReadOnly Property G As Byte
Property Value
System.Byte

The green component of this Color instance.

IsEmpty

Gets a value indicating whether this Color instance is empty.

public readonly bool IsEmpty { get; }
Public ReadOnly Property IsEmpty As Boolean
Property Value
System.Boolean

true if this Color instance is empty; otherwise, false.

R

Gets the red component of this Color instance.

public readonly byte R { get; }
Public ReadOnly Property R As Byte
Property Value
System.Byte

The red component of this Color instance.

Methods

Equals(Color)

Determines whether the other Color is equal to this Color instance.

public bool Equals(Color other)
Public Function Equals(other As Color) As Boolean
Parameters
other
Color

The other color to compare with this color instance.

Returns
System.Boolean

true if the other Color is equal to this Color instance; otherwise, false.

Equals(Object)

Determines whether the specified System.Object is equal to this Color instance.

public override bool Equals(object obj)
Public Overrides Function Equals(obj As Object) As Boolean
Parameters
obj
System.Object

The System.Object to compare with this color instance.

Returns
System.Boolean

true if the specified System.Object is a Color and is equal to this Color instance; otherwise, false.

Overrides
System.ValueType.Equals(System.Object)

GetHashCode()

Returns a hash code for this Color instance.

public override int GetHashCode()
Public Overrides Function GetHashCode As Integer
Returns
System.Int32

An integer value that specifies a hash value for this Color instance.

Overrides
System.ValueType.GetHashCode()

ToString()

Returns a System.String that represents this Color instance.

public override string ToString()
Public Overrides Function ToString As String
Returns
System.String

A System.String that represents this Color instance.

Overrides
System.ValueType.ToString()

Operators

Equality(Color, Color)

Determines whether first and second Colors are equal.

public static bool operator ==(Color first, Color second)
Public Shared Operator =(first As Color, second As Color) As Boolean
Parameters
first
Color

The first color.

second
Color

The second color.

Returns
System.Boolean

true if first and second colors are equal; otherwise, false.

Inequality(Color, Color)

Determines whether first and second Colors are not equal.

public static bool operator !=(Color first, Color second)
Public Shared Operator <>(first As Color, second As Color) As Boolean
Parameters
first
Color

The first color.

second
Color

The second color.

Returns
System.Boolean

true if first and second colors are not equal; otherwise, false.

Implements

System.IEquatable<T>