Skip to content
ChartForgeX
Struct

Tone

ChartForgeX

Namespace
ChartForgeX
Assembly
ChartForgeX
Base
ValueType
Implements
IEquatable<Tone>
Modifiers
sealed

The emphasis an element is painted with: a built-in tone or a named one that the theme defines. Domain facts such as a status or severity map to a tone for paint. The name is the wire spelling, compared without regard to case.

Inheritance

  • ValueType
  • Tone

Usage

Explore 54 API references to this type

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

Accepted by parameters 25

Methods

Equals 2 overloads
public bool Equals(Tone other) #

Indicates whether the current object is equal to another object of the same type.

Parameters

other ChartForgeX.Tone required
An object to compare with this object.

Returns

bool true if the current object is equal to the other parameter; otherwise, false.
public override bool Equals(object obj) #

Indicates whether this instance and a specified object are equal.

Parameters

obj object required
The object to compare with the current instance.

Returns

bool true if obj and this instance are the same type and represent the same value; otherwise, false.
public override int GetHashCode() #

Returns the hash code for this instance.

Returns

int A 32-bit signed integer that is the hash code for this instance.
public static Tone Named(string name) #

A tone the theme defines by name; a theme without it paints the element as Tone.Neutral.

Parameters

name string required
Letters, digits, hyphens, underscores and dots.

Returns

Tone The tone.
public static bool op_Equality(Tone left, Tone right) #

Whether two tones have the same name.

Parameters

left ChartForgeX.Tone required
right ChartForgeX.Tone required

Returns

bool
public static bool op_Inequality(Tone left, Tone right) #

Whether two tones have different names.

Parameters

left ChartForgeX.Tone required
right ChartForgeX.Tone required

Returns

bool
public static Tone Parse(string value) #

Reads a built-in or theme-defined tone, ignoring case.

Parameters

value string required
The name.

Returns

Tone The tone.
public override string ToString() #

The wire spelling.

Returns

string The name.
public static bool TryParse(string value, out Tone tone) #

Reads a built-in or theme-defined tone, ignoring case.

Parameters

value string required
The name.
tone ChartForgeX.Tone required
The tone, when the name is valid.

Returns

bool Whether the name is valid.

Properties

public static Tone None { get; } #

No tone: the element keeps its default paint.

public static Tone Neutral { get; } #

A neutral emphasis.

public static Tone Info { get; } #

Information.

public static Tone Success { get; } #

A good or completed state.

public static Tone Warning { get; } #

Something that needs attention.

public static Tone Danger { get; } #

A failure or a destructive action.

public static Tone Muted { get; } #

De-emphasized content.

public string Name { get; } #

The wire spelling: none, a built-in tone or a theme-defined name.

public bool IsNamed { get; } #

Whether this is a theme-defined tone rather than a built-in one.