FileConfigurationSource Class

Definition

Represents a base class for file based IConfigurationSource.

public ref class FileConfigurationSource abstract : Microsoft::Extensions::Configuration::IConfigurationSource
public abstract class FileConfigurationSource : Microsoft.Extensions.Configuration.IConfigurationSource
type FileConfigurationSource = class
    interface IConfigurationSource
Public MustInherit Class FileConfigurationSource
Implements IConfigurationSource
Inheritance
FileConfigurationSource
Derived
Implements

Constructors

FileConfigurationSource()

Properties

FileProvider

Used to access the contents of the file.

OnLoadException

Will be called if an uncaught exception occurs in FileConfigurationProvider.Load.

Optional

Determines if loading the file is optional.

Path

The path to the file.

ReloadDelay

Number of milliseconds that reload will wait before calling Load. This helps avoid triggering reload before a file is completely written. Default is 250.

ReloadOnChange

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

Methods

Build(IConfigurationBuilder)

Builds the IConfigurationProvider for this source.

EnsureDefaults(IConfigurationBuilder)

Called to use any default settings on the builder like the FileProvider or FileLoadExceptionHandler.

Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ResolveFileProvider()

If no file provider has been set, for absolute Path, this will creates a physical file provider for the nearest existing directory.

ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to