IconifyIconSet Class

Namespace: Meziantou.Framework
Assembly: Meziantou.Framework.Iconify.dll
Package: Meziantou.Framework.Iconify 1.0.1
Source: IconifyIconSet.cs
Available in package assets: net10.0net11.0

Represents an icon set loaded from a file in the IconifyJSON format, using Iconify.Load.

public sealed class IconifyIconSet

Properties

Name	Description
Count	Gets the number of icons and aliases in the icon set.
Icons	Gets the icons and the aliases of the icon set, including the hidden icons.
Info	Gets the description of the icon set, or `null` when the file has no `info` property.
Prefix	Gets the prefix of the icon set, such as `mdi`.

Count

IconifyIconSet.cs

Gets the number of icons and aliases in the icon set.

public int Count { get; }

Property value

int

Icons

IconifyIconSet.cs

Gets the icons and the aliases of the icon set, including the hidden icons.

public IReadOnlyList<IconifyIcon> Icons { get; }

Property value

IReadOnlyList<IconifyIcon>

Info

IconifyIconSet.cs

Gets the description of the icon set, or null when the file has no info property.

public IconifyIconSetInfo? Info { get; }

Property value

IconifyIconSetInfo?

Prefix

IconifyIconSet.cs

Gets the prefix of the icon set, such as mdi.

public string Prefix { get; }

Property value

string

Indexers

Name	Description
this[string]	Gets the icon or the alias with the specified name. The comparison is case-sensitive.

this[string]

IconifyIconSet.cs

Gets the icon or the alias with the specified name. The comparison is case-sensitive.

public IconifyIcon this[string name] { get; }

Parameters

name string: The name of the icon, such as account-circle.

Property value

IconifyIcon

Exceptions

KeyNotFoundException: The icon set has no icon with this name.

Methods

Name	Description
ContainsIcon(string)	Determines whether the icon set has an icon or an alias with the specified name. The comparison is case-sensitive.
TryGetIcon(string, IconifyIcon?)	Gets the icon or the alias with the specified name. The comparison is case-sensitive.

ContainsIcon(string)

IconifyIconSet.cs

Determines whether the icon set has an icon or an alias with the specified name. The comparison is case-sensitive.

public bool ContainsIcon(string name)

Parameters

name string: The name of the icon, such as account-circle.

Returns

bool true when the icon set has an icon with this name; otherwise, false.

TryGetIcon(string, IconifyIcon?)

IconifyIconSet.cs

Gets the icon or the alias with the specified name. The comparison is case-sensitive.

public bool TryGetIcon(string name, out IconifyIcon? icon)

Parameters

name string: The name of the icon, such as account-circle.
icon IconifyIcon?: The icon, when it exists.

Returns

bool true when the icon set has an icon with this name; otherwise, false.