Interface IGorgonOption

An option to be stored in a IGorgonOptionBag.

Inherited Members
Namespace: Gorgon.Configuration
Assembly: Gorgon.Core.dll
Syntax
public interface IGorgonOption : IGorgonNamedObject

Properties

| Edit this page View Source

Type

Property to return the type of data stored in the option.

Declaration
Type Type { get; }
Property Value
Type Description
Type

Methods

| Edit this page View Source

GetDefaultValue<T>()

Function to retrieve the default value for this option.

Declaration
T GetDefaultValue<T>()
Returns
Type Description
T

The value, strongly typed.
Type Parameters
Name Description
T

The type of the value.
| Edit this page View Source

GetMaxValue<T>()

Function to retrieve the maximum allowed value for this option.

Declaration
T GetMaxValue<T>()
Returns
Type Description
T

The value, strongly typed.
Type Parameters
Name Description
T

The type of the value.
| Edit this page View Source

GetMinValue<T>()

Function to retrieve the minimum allowed value for this option.

Declaration
T GetMinValue<T>()
Returns
Type Description
T

The value, strongly typed.
Type Parameters
Name Description
T

The type of the value.
| Edit this page View Source

GetValue<T>()

Function to retrieve the value stored in this option.

Declaration
T GetValue<T>()
Returns
Type Description
T

The value, strongly typed.
Type Parameters
Name Description
T

The type for the value.
| Edit this page View Source

SetValue<T>(T)

Function to assign a value for the option.

Declaration
void SetValue<T>(T value)
Parameters
Type Name Description
T value

The value to assign.
Type Parameters
Name Description
T

The type parmeter for the value.

Extension Methods