Interface IConfigurationSectionDescriptor

Describes a configuration section

Namespace: Snowflake.Configuration

Assembly: Snowflake.Framework.Primitives.dll

Syntax

public interface IConfigurationSectionDescriptor

Properties

Description

Gets the description of the section

Declaration

string Description { get; }

Property Value

Type	Description
System.String

DisplayName

Gets the human readable name of the section

Declaration

string DisplayName { get; }

Property Value

Type	Description
System.String

Item[String]

Gets the configuration option with the specified property name

Declaration

IConfigurationOptionDescriptor this[string optionKey] { get; }

Parameters

Type	Name	Description
System.String	optionKey	The property name of the option as declared

Property Value

Type	Description
IConfigurationOptionDescriptor	The configuration option

Options

Gets the list of configuration options in the section ordered as they were declared as properties. The implementation is responsible for ensuring this is immutable and correctly ordered.

Declaration

IEnumerable<IConfigurationOptionDescriptor> Options { get; }

Property Value

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

SectionKey

The key of the section as it is described in its parent Collection.

Declaration

string SectionKey { get; }

Property Value

Type	Description
System.String

SectionName

Gets the name of the section as it appears in configuration.

Declaration

string SectionName { get; }

Property Value

Type	Description
System.String