Class EnumSettingDescriptor

Descriptor for a dropdown / combo-box setting. The Options list defines the available choices.

Inheritance

object

SettingDescriptor

EnumSettingDescriptor

Inherited Members

SettingDescriptor.Key

SettingDescriptor.DisplayName

SettingDescriptor.Description

SettingDescriptor.IconSvg

SettingDescriptor.IsVisible

SettingDescriptor.IsRequired

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Zaya.Primitives

Assembly: Zaya.Primitives.dll

Syntax

public sealed class EnumSettingDescriptor : SettingDescriptor

Constructors

EnumSettingDescriptor(string, LocalizedString)

Initializes a new instance of the EnumSettingDescriptor class.

Declaration

public EnumSettingDescriptor(string key, LocalizedString displayName)

Parameters

Type	Name	Description
string	key	Machine-readable key for this setting.
LocalizedString	displayName	Localizable UI label.

Properties

DefaultValue

Gets or sets the default selected option value (must match one of the Options values).

Declaration

public string? DefaultValue { get; init; }

Property Value

Type	Description
string

Options

Gets or sets the list of available choices for this setting.

Declaration

public IReadOnlyList<EnumOption> Options { get; init; }

Property Value

Type	Description
IReadOnlyList<EnumOption>