通过

ConfigurationSection Class

Definition

Namespace:
Microsoft.Extensions.Configuration
Assembly:
Microsoft.Extensions.Configuration.dll
Package:
Microsoft.Extensions.Configuration v10.0.0
Source:
ConfigurationSection.cs
Source:
ConfigurationSection.cs
Source:
ConfigurationSection.cs

Represents a section of application configuration values.

public ref class ConfigurationSection : Microsoft::Extensions::Configuration::IConfigurationSection
public class ConfigurationSection : Microsoft.Extensions.Configuration.IConfigurationSection
type ConfigurationSection = class
    interface IConfigurationSection
    interface IConfiguration
Public Class ConfigurationSection
Implements IConfigurationSection
Inheritance
Object
ConfigurationSection
Implements
IConfiguration IConfigurationSection

Constructors

Name Description
ConfigurationSection(IConfigurationRoot, String)

Initializes a new instance.

Properties

Name Description
Item[String]

Gets or sets the value corresponding to a configuration key.
Key

Gets the key this section occupies in its parent.
Path

Gets the full path to this section from the IConfigurationRoot.
Value

Gets or sets the section value.

Methods

Name Description
GetChildren()

Gets the immediate descendant configuration sub-sections.
GetReloadToken()

Returns a IChangeToken that can be used to observe when this configuration is reloaded.
GetSection(String)

Gets a configuration sub-section with the specified key.
TryGetValue(String, String)

Tries to get the value of this section as a string.

Extension Methods

Name Description
AsEnumerable(IConfiguration, Boolean)

Get the enumeration of key value pairs within the IConfiguration
AsEnumerable(IConfiguration)

Get the enumeration of key value pairs within the IConfiguration
Bind(IConfiguration, Object, Action<BinderOptions>)

Attempts to bind the given object instance to configuration values by matching property names against configuration keys recursively.
Bind(IConfiguration, Object)

Attempts to bind the given object instance to configuration values by matching property names against configuration keys recursively.
Bind(IConfiguration, String, Object)

Attempts to bind the given object instance to the configuration section specified by the key by matching property names against configuration keys recursively.
Exists(IConfigurationSection)

Determines whether the section has a Value or has children.
Get(IConfiguration, Type, Action<BinderOptions>)

Attempts to bind the configuration instance to a new instance of type T. If this configuration section has a value, that will be used. Otherwise binding by matching property names against configuration keys recursively.
Get(IConfiguration, Type)

Attempts to bind the configuration instance to a new instance of type T. If this configuration section has a value, that will be used. Otherwise binding by matching property names against configuration keys recursively.
Get<T>(IConfiguration, Action<BinderOptions>)

Attempts to bind the configuration instance to a new instance of type T. If this configuration section has a value, that will be used. Otherwise binding by matching property names against configuration keys recursively.
Get<T>(IConfiguration)

Attempts to bind the configuration instance to a new instance of type T. If this configuration section has a value, that will be used. Otherwise binding by matching property names against configuration keys recursively.
GetConnectionString(IConfiguration, String)

Gets the specified connection string from the specified configuration. Shorthand for GetSection("ConnectionStrings")[name].
GetRequiredSection(IConfiguration, String)

Gets a configuration subsection with the specified key.
GetValue(IConfiguration, Type, String, Object)

Extracts the value with the specified key and converts it to the specified type.
GetValue(IConfiguration, Type, String)

Extracts the value with the specified key and converts it to the specified type.
GetValue<T>(IConfiguration, String, T)

Extracts the value with the specified key and converts it to type T.
GetValue<T>(IConfiguration, String)

Extracts the value with the specified key and converts it to type T.

Applies to