FileConfigurationSource Class

Represents a base class for file based Microsoft.Extensions.Configuration.IConfigurationSource.

Namespace
Microsoft.Extensions.Configuration
Assemblies
  • Microsoft.Extensions.Configuration.FileExtensions

Syntax

public abstract class FileConfigurationSource : IConfigurationSource
class Microsoft.Extensions.Configuration.FileConfigurationSource

Methods

Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)

Builds the Microsoft.Extensions.Configuration.IConfigurationProvider for this source.

Arguments:builder (Microsoft.Extensions.Configuration.IConfigurationBuilder) – The Microsoft.Extensions.Configuration.IConfigurationBuilder.
Return type:Microsoft.Extensions.Configuration.IConfigurationProvider
Returns:A Microsoft.Extensions.Configuration.IConfigurationProvider 
public abstract IConfigurationProvider Build(IConfigurationBuilder builder)

Properties

Microsoft.Extensions.Configuration.FileConfigurationSource.FileProvider

Used to access the contents of the file.

Return type:Microsoft.Extensions.FileProviders.IFileProvider 
public IFileProvider FileProvider { get; set; }
Microsoft.Extensions.Configuration.FileConfigurationSource.Optional

Determines if loading the file is optional.

Return type:System.Boolean 
public bool Optional { get; set; }
Microsoft.Extensions.Configuration.FileConfigurationSource.Path

The path to the file.

Return type:System.String 
public string Path { get; set; }
Microsoft.Extensions.Configuration.FileConfigurationSource.ReloadOnChange

Determines whether the source will be loaded if the underlying file changes.

Return type:System.Boolean 
public bool ReloadOnChange { get; set; }