Get Started

API Reference

Struct

MarkdownColor

Edit on GitHub
Namespace OfficeIMO.Markdown
Assembly OfficeIMO.Markdown
Source OfficeIMO.Markdown/Options/MarkdownColor.cs:102
Base ValueType
Implements
IEquatable<MarkdownColor>
Modifiers sealed

Renderer-neutral RGB or RGBA color used by shared Markdown visual themes, accepting hex values and Office-style named colors.

Inheritance

  • ValueType
  • MarkdownColor

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Accepted by parameters

Constructors

public MarkdownColor(Byte r, Byte g, Byte b, Byte a = 255) #
OfficeIMO.Markdown/Options/MarkdownColor.cs:102

Creates an RGB or RGBA Markdown color.

Parameters

r System.Byte requiredposition: 0
g System.Byte requiredposition: 1
b System.Byte requiredposition: 2
a System.Byte = 255 optionalposition: 3

Methods

Equals 2 overloads
public virtual Boolean Equals(MarkdownColor other) #
OfficeIMO.Markdown/Options/MarkdownColor.cs:160
Returns: Boolean

Parameters

other OfficeIMO.Markdown.MarkdownColor requiredposition: 0
public override Boolean Equals(Object obj) #
OfficeIMO.Markdown/Options/MarkdownColor.cs:163
Returns: Boolean

Parameters

obj System.Object requiredposition: 0
public static MarkdownColor FromRgb(Byte r, Byte g, Byte b) #
OfficeIMO.Markdown/Options/MarkdownColor.cs:121
Returns: MarkdownColor

Creates an opaque color from RGB components.

Parameters

r System.Byte requiredposition: 0
g System.Byte requiredposition: 1
b System.Byte requiredposition: 2
public override Int32 GetHashCode() #
OfficeIMO.Markdown/Options/MarkdownColor.cs:166
Returns: Int32
op_Equality(OfficeIMO.Markdown.MarkdownColor left, OfficeIMO.Markdown.MarkdownColor right) #

Equality operator.

Parameters

left OfficeIMO.Markdown.MarkdownColor required
right OfficeIMO.Markdown.MarkdownColor required
op_Inequality(OfficeIMO.Markdown.MarkdownColor left, OfficeIMO.Markdown.MarkdownColor right) #

Inequality operator.

Parameters

left OfficeIMO.Markdown.MarkdownColor required
right OfficeIMO.Markdown.MarkdownColor required
public static MarkdownColor Parse(String value) #
OfficeIMO.Markdown/Options/MarkdownColor.cs:125
Returns: MarkdownColor

Parses a named color, #RGB, RGB, #RRGGBB, RRGGBB, #RRGGBBAA, or RRGGBBAA value.

Parameters

value System.String requiredposition: 0
public String ToCssColor() #
OfficeIMO.Markdown/Options/MarkdownColor.cs:148
Returns: String

Returns the color as #RRGGBB or #RRGGBBAA.

public String ToRgbaHex() #
OfficeIMO.Markdown/Options/MarkdownColor.cs:154
Returns: String

Returns RRGGBBAA.

public String ToRgbHex() #
OfficeIMO.Markdown/Options/MarkdownColor.cs:151
Returns: String

Returns RRGGBB.

public override String ToString() #
OfficeIMO.Markdown/Options/MarkdownColor.cs:157
Returns: String
public static Boolean TryParse(String value, out MarkdownColor color) #
OfficeIMO.Markdown/Options/MarkdownColor.cs:134
Returns: Boolean

Tries to parse a named or hexadecimal color.

Parameters

value System.String requiredposition: 0
color OfficeIMO.Markdown.MarkdownColor@ requiredposition: 1

Properties

public Byte R { get; } #
OfficeIMO.Markdown/Options/MarkdownColor.cs:109

Red component.

public Byte G { get; } #
OfficeIMO.Markdown/Options/MarkdownColor.cs:112

Green component.

public Byte B { get; } #
OfficeIMO.Markdown/Options/MarkdownColor.cs:115

Blue component.

public Byte A { get; } #
OfficeIMO.Markdown/Options/MarkdownColor.cs:118

Alpha component.