Class ConfigurationOptionAttribute

Represents one option in an emulator configuration inside a configuration section. Typically configuration options must be a double, bool, integer or an enum value in order to be safe, type information may be lost when serializing into a wire format.

Inheritance

System.Object

System.Attribute

ConfigurationOptionAttribute

Inherited Members

System.Attribute.Equals(System.Object)

System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type)

System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type, System.Boolean)

System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type)

System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type, System.Boolean)

System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type)

System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type, System.Boolean)

System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type)

System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.Assembly)

System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type)

System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo)

System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type)

System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.Module)

System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type)

System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo)

System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type)

System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type, System.Boolean)

System.Attribute.GetHashCode()

System.Attribute.IsDefaultAttribute()

System.Attribute.IsDefined(System.Reflection.Assembly, System.Type)

System.Attribute.IsDefined(System.Reflection.Assembly, System.Type, System.Boolean)

System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type)

System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type, System.Boolean)

System.Attribute.IsDefined(System.Reflection.Module, System.Type)

System.Attribute.IsDefined(System.Reflection.Module, System.Type, System.Boolean)

System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type)

System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type, System.Boolean)

System.Attribute.Match(System.Object)

System.Attribute.TypeId

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Snowflake.Configuration.Attributes

Assembly: Snowflake.Framework.Primitives.dll

Syntax

[AttributeUsage(AttributeTargets.Property)]
public sealed class ConfigurationOptionAttribute : Attribute

Constructors

ConfigurationOptionAttribute(String, Boolean)

Initializes a new instance of the ConfigurationOptionAttribute class. Represents one option in an emulator configuration inside a configuration section. Typically configuration options must be a double, bool, integer or an enum value in order to be safe, type information may be lost when serializing into a wire format.

Declaration

public ConfigurationOptionAttribute(string optionName, bool default)

Parameters

Type	Name	Description
System.String	optionName
System.Boolean	default

ConfigurationOptionAttribute(String, Double)

Initializes a new instance of the ConfigurationOptionAttribute class. Represents one option in an emulator configuration inside a configuration section. Typically configuration options must be a double, bool, integer or an enum value in order to be safe, type information may be lost when serializing into a wire format.

Declaration

public ConfigurationOptionAttribute(string optionName, double default)

Parameters

Type	Name	Description
System.String	optionName	The name of the option
System.Double	default	The default value of the option. Note that only strings, enums and primitive types are supported.

ConfigurationOptionAttribute(String, Int32)

Initializes a new instance of the ConfigurationOptionAttribute class. Represents one option in an emulator configuration inside a configuration section. Typically configuration options must be a double, bool, integer or an enum value in order to be safe, type information may be lost when serializing into a wire format.

Declaration

public ConfigurationOptionAttribute(string optionName, int default)

Parameters

Type	Name	Description
System.String	optionName
System.Int32	default

ConfigurationOptionAttribute(String, Object)

Initializes a new instance of the ConfigurationOptionAttribute class. Represents one option in an emulator configuration inside a configuration section. Typically configuration options must be a double, bool, integer or an enum value in order to be safe, type information may be lost when serializing into a wire format.

Declaration

public ConfigurationOptionAttribute(string optionName, object default)

Parameters

Type	Name	Description
System.String	optionName	The name of the option
System.Object	default	The default value of the option. Note that only strings, enums and primitive types are supported.

ConfigurationOptionAttribute(String, String)

Initializes a new ConfigurationOptionAttribute. Represents one option in an emulator configuration inside a configuration section. Typically configuration options must be a double, bool, integer or an enum value in order to be safe, type information may be lost when serializing into a wire format.

Declaration

public ConfigurationOptionAttribute(string optionName, string default)

Parameters

Type	Name	Description
System.String	optionName	The name of the option
System.String	default	The default value of the option. Note that only strings, enums and primitive types are supported.

ConfigurationOptionAttribute(String, String, PathType)

Initializes a new ConfigurationOptionAttribute that represents a path. Represents one option in an emulator configuration inside a configuration section. Typically configuration options must be a double, bool, integer or an enum value in order to be safe, type information may be lost when serializing into a wire format.

Declaration

public ConfigurationOptionAttribute(string optionName, string default, PathType pathType)

Parameters

Type	Name	Description
System.String	optionName	The name of the option
System.String	default	The default value of the option. Note that only strings, enums and primitive types are supported.
PathType	pathType	The type of the path this points to.

ConfigurationOptionAttribute(String, String, String)

Initializes a new ConfigurationOptionAttribute with a non default unset. This must be used if the default value is null.

Represents one option in an emulator configuration inside a configuration section. Typically configuration options must be a double, bool, integer or an enum value in order to be safe, type information may be lost when serializing into a wire format.

Declaration

public ConfigurationOptionAttribute(string optionName, string default, string unset)

Parameters

Type	Name	Description
System.String	optionName	The name of the option
System.String	default	The default value of the option. Note that only strings, enums and primitive types are supported.
System.String	unset

Properties

Default

Gets the default value of this option.

Declaration

public object Default { get; }

Property Value

Type	Description
System.Object

Description

Gets or sets a description of this configuration option

Declaration

public string Description { get; set; }

Property Value

Type	Description
System.String

DisplayName

Gets or sets the display name for human readable purposes of this option

Declaration

public string DisplayName { get; set; }

Property Value

Type	Description
System.String

Flag

Gets or sets 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

public bool Flag { get; set; }

Property Value

Type	Description
System.Boolean

Increment

Gets or sets the increment to increase a numerical value by

Declaration

public double Increment { get; set; }

Property Value

Type	Description
System.Double

Max

Gets or sets the maximum value allowable for a number value

Declaration

public double Max { get; set; }

Property Value

Type	Description
System.Double

Min

Gets or sets the minimum value allowable for a number value

Declaration

public double Min { get; set; }

Property Value

Type	Description
System.Double

OptionName

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

Declaration

public string OptionName { get; }

Property Value

Type	Description
System.String

PathType

If this option is a path, specifies the type of the path.

Declaration

public PathType PathType { get; }

Property Value

Type	Description
PathType

Private

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

Declaration

public bool Private { get; set; }

Property Value

Type	Description
System.Boolean

Simple

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

Declaration

public bool Simple { get; set; }

Property Value

Type	Description
System.Boolean

Unset

A serialization of the null string. If a string option type is set to null, then when serialized will be set to this unset.

Declaration

public string Unset { get; }

Property Value

Type	Description
System.String

See Also

System.Attribute