Class OptionInfo

One configurable option, see OptionCatalog.

Inheritance

object

OptionInfo

Implements

IEquatable<OptionInfo>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Uniform.Matrix.Hosting

Assembly: Uniform.Matrix.Hosting.dll

Syntax

public sealed record OptionInfo : IEquatable<OptionInfo>

Properties

Choices

Allowed values of enum and boolean options; empty for free text.

Declaration

public IReadOnlyList<string> Choices { get; }

Property Value

Type	Description
IReadOnlyList<string>

DefaultValue

Built-in default as configuration text, or null.

Declaration

public string? DefaultValue { get; init; }

Property Value

Type	Description
string

Description

What the option does.

Declaration

public string Description { get; init; }

Property Value

Type	Description
string

Key

Configuration key, e.g. Ui:InlineImages.

Declaration

public required string Key { get; init; }

Property Value

Type	Description
string

RestartRequired

Whether a change takes effect only after a restart.

Declaration

public bool RestartRequired { get; init; }

Property Value

Type	Description
bool

Secret

Whether the value is secret and not shown or saved, see SecretAttribute.

Declaration

public bool Secret { get; init; }

Property Value

Type	Description
bool

Type

Value type; nullable types allow an empty value.

Declaration

public required Type Type { get; init; }

Property Value

Type	Description
Type

Methods

Parse(string)

Return text normalized for configuration, or an error message; empty text means unset for nullable types.

Declaration

public (string? Value, string? Error) Parse(string text)

Parameters

Type	Name	Description
string	text

Returns

Type	Description
(string Username, string Password)

Implements

IEquatable<T>