Interface IConfigurationOptionDescriptor

Describes a configuration option.

Namespace: Snowflake.Configuration

Assembly: Snowflake.Framework.Primitives.dll

Syntax

public interface IConfigurationOptionDescriptor

Properties

CustomMetadata

Gets any custom metadata attached to this option

Declaration

IDictionary<string, object> CustomMetadata { get; }

Property Value

Type	Description
System.Collections.Generic.IDictionary<System.String, System.Object>

Default

Gets the default object.

Declaration

object Default { get; }

Property Value

Type	Description
System.Object

Description

Gets a description of this configuration option

Declaration

string Description { get; }

Property Value

Type	Description
System.String

DisplayName

Gets the display name for human readable purposes of this option

Declaration

string DisplayName { get; }

Property Value

Type	Description
System.String

Flag

Gets a value indicating whether a 'flag' property is never serialized into the configuration option, and is instead used to cause side effects to the configuration during emulator instance creation by the emulator handler. If a flag affects the configuration, it should be placed in the same section it modifies.

Declaration

bool Flag { get; }

Property Value

Type	Description
System.Boolean

Increment

Gets the increment to increase this by

Declaration

double Increment { get; }

Property Value

Type	Description
System.Double

IsPath

Gets a value indicating whether whether or not this string is a file path.

Declaration

bool IsPath { get; }

Property Value

Type	Description
System.Boolean

IsSelection

Gets a value indicating whether whether or not this option is an enum.

Declaration

bool IsSelection { get; }

Property Value

Type	Description
System.Boolean

Max

Gets the maximum value allowable for a number value

Declaration

double Max { get; }

Property Value

Type	Description
System.Double

Min

Gets the minimum value allowable for a number value

Declaration

double Min { get; }

Property Value

Type	Description
System.Double

OptionKey

Gets the key of the configuration option

Declaration

string OptionKey { get; }

Property Value

Type	Description
System.String

OptionName

Gets the name of the option as it appears inside the emulator configuration

Declaration

string OptionName { get; }

Property Value

Type	Description
System.String

OptionType

Gets the option type of the option

Declaration

ConfigurationOptionType OptionType { get; }

Property Value

Type	Description
ConfigurationOptionType

PathType

If IsPath is true, the type of the path.

Declaration

PathType PathType { get; }

Property Value

Type	Description
PathType

Private

Gets a value indicating whether whether or not this option is private (not ever displayed to the user)

Declaration

bool Private { get; }

Property Value

Type	Description
System.Boolean

SelectionOptions

Gets a list of selection option descriptors if this option is an enum.

Declaration

IEnumerable<ISelectionOptionDescriptor> SelectionOptions { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<ISelectionOptionDescriptor>

Simple

Gets a value indicating whether whether or not this option is a simple option (displayed in "Simple" configuration mode)

Declaration

bool Simple { get; }

Property Value

Type	Description
System.Boolean

Type

Gets the CLR type of the option

Declaration

Type Type { get; }

Property Value

Type	Description
System.Type

Unset

For string options, when the option is set to null, it is serialized as this value.

Declaration

string Unset { get; }

Property Value

Type	Description
System.String