Show / Hide Table of Contents

Class EnumOption

Represents a single option in an enum-style setting, pairing a machine-readable value with a localizable display name and optional description.

Inheritance
object
EnumOption
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Zaya.Primitives
Assembly: Zaya.Primitives.dll
Syntax
public class EnumOption

Constructors

| Edit this page View Source

EnumOption(string, LocalizedString, LocalizedString?)

Initializes a new instance of the EnumOption class.

Declaration
public EnumOption(string value, LocalizedString displayName, LocalizedString? description = null)
Parameters
Type Name Description
string value

Machine-readable option value.

LocalizedString displayName

UI display name.

LocalizedString description

Optional description (tooltip).

Properties

| Edit this page View Source

Description

Gets the optional localizable description (tooltip / help text).

Declaration
public LocalizedString? Description { get; }
Property Value
Type Description
LocalizedString
| Edit this page View Source

DisplayName

Gets the localizable display name shown in the UI.

Declaration
public LocalizedString DisplayName { get; }
Property Value
Type Description
LocalizedString
| Edit this page View Source

Value

Gets the machine-readable value (e.g. "snippingtool", "directory").

Declaration
public string Value { get; }
Property Value
Type Description
string
  • Edit this page
  • View Source
In this article
Back to top Generated by DocFX