Skip to content
ChartForgeX
Struct

Icon

ChartForgeX

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

An icon catalog key such as server or tabler:server. Each renderer binds the key to its own artwork (glyph, SVG path or emoji fallback), so a key is never a URL or markup. Keys are compared without regard to case.

Inheritance

  • ValueType
  • Icon

Usage

Explore 21 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.

Returned or exposed by 13

Accepted by parameters 8

Methods

Equals 2 overloads
public bool Equals(Icon other) #

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

Parameters

other ChartForgeX.Icon 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 Icon Named(string key) #

An icon by catalog key.

Parameters

key string required
Letters, digits, hyphens, underscores and dots, optionally after a pack: prefix.

Returns

Icon The icon.
public static bool op_Equality(Icon left, Icon right) #

Whether two icons have the same key.

Parameters

left ChartForgeX.Icon required
right ChartForgeX.Icon required

Returns

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

Whether two icons have different keys.

Parameters

left ChartForgeX.Icon required
right ChartForgeX.Icon required

Returns

bool
public static Icon Parse(string value) #

Reads an icon key, ignoring case.

Parameters

value string required
The key.

Returns

Icon The icon.
public override string ToString() #

The catalog key.

Returns

string The key.
public static bool TryParse(string value, out Icon icon) #

Reads an icon key, ignoring case. An empty value is Icon.None.

Parameters

value string required
The key.
icon ChartForgeX.Icon required
The icon, when the key is valid.

Returns

bool Whether the key is valid.

Properties

public static Icon None { get; } #

No icon.

public string Key { get; } #

The catalog key, or an empty string for Icon.None.

public bool IsEmpty { get; } #

Whether no icon is set.