KeyPerFileConfigurationSource.xml

<TypeName="KeyPerFileConfigurationSource"FullName="Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource">
 <TypeSignatureLanguage="C#"Value="public class KeyPerFileConfigurationSource : Microsoft.Extensions.Configuration.IConfigurationSource" />
 <TypeSignatureLanguage="ILAsm"Value=".class public auto ansi beforefieldinit KeyPerFileConfigurationSource extends System.Object implements class Microsoft.Extensions.Configuration.IConfigurationSource" />
 <TypeSignatureLanguage="DocId"Value="T:Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource" />
 <TypeSignatureLanguage="VB.NET"Value="Public Class KeyPerFileConfigurationSource&#xA;Implements IConfigurationSource" />
 <TypeSignatureLanguage="F#"Value="type KeyPerFileConfigurationSource = class&#xA; interface IConfigurationSource" />
 <TypeSignatureLanguage="C++ CLI"Value="public ref class KeyPerFileConfigurationSource : Microsoft::Extensions::Configuration::IConfigurationSource" />
 <AssemblyInfo>
 <AssemblyName>Microsoft.Extensions.Configuration.KeyPerFile</AssemblyName>
 <AssemblyVersion>2.1.0.0</AssemblyVersion>
 <AssemblyVersion>2.2.0.0</AssemblyVersion>
 <AssemblyVersion>3.0.0.0</AssemblyVersion>
 <AssemblyVersion>3.1.0.0</AssemblyVersion>
 <AssemblyVersion>5.0.0.0</AssemblyVersion>
 <AssemblyVersion>6.0.0.0</AssemblyVersion>
 <AssemblyVersion>7.0.0.0</AssemblyVersion>
 <AssemblyVersion>8.0.0.0</AssemblyVersion>
 <AssemblyVersion>9.0.0.0</AssemblyVersion>
 <AssemblyVersion>10.0.0.0</AssemblyVersion>
 </AssemblyInfo>
 <Base>
 <BaseTypeName>System.Object</BaseTypeName>
 </Base>
 <Interfaces>
 <Interface>
 <InterfaceName>Microsoft.Extensions.Configuration.IConfigurationSource</InterfaceName>
 </Interface>
 </Interfaces>
 <Attributes>
 <AttributeFrameworkAlternate="net-10.0-pp">
 <AttributeNameLanguage="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
 <AttributeNameLanguage="F#">[&lt;System.Runtime.CompilerServices.Nullable(0)&gt;]</AttributeName>
 </Attribute>
 </Attributes>
 <Docs>
 <summary>
 An <seecref="T:Microsoft.Extensions.Configuration.IConfigurationSource" /> used to configure <seecref="T:Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationProvider" />.
 </summary>
 <remarks>To be added.</remarks>
 </Docs>
 <Members>
 <MemberMemberName=".ctor">
 <MemberSignatureLanguage="C#"Value="public KeyPerFileConfigurationSource ();" />
 <MemberSignatureLanguage="ILAsm"Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
 <MemberSignatureLanguage="DocId"Value="M:Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.#ctor" />
 <MemberSignatureLanguage="VB.NET"Value="Public Sub New ()" />
 <MemberSignatureLanguage="C++ CLI"Value="public:&#xA; KeyPerFileConfigurationSource();" />
 <MemberType>Constructor</MemberType>
 <AssemblyInfo>
 <AssemblyName>Microsoft.Extensions.Configuration.KeyPerFile</AssemblyName>
 <AssemblyVersion>10.0.0.0</AssemblyVersion>
 </AssemblyInfo>
 <Parameters />
 <Docs>
 <summary>
 Constructor;
 </summary>
 <remarks>To be added.</remarks>
 </Docs>
 </Member>
 <MemberMemberName="Build">
 <MemberSignatureLanguage="C#"Value="public Microsoft.Extensions.Configuration.IConfigurationProvider Build (Microsoft.Extensions.Configuration.IConfigurationBuilder builder);" />
 <MemberSignatureLanguage="ILAsm"Value=".method public hidebysig newslot virtual instance class Microsoft.Extensions.Configuration.IConfigurationProvider Build(class Microsoft.Extensions.Configuration.IConfigurationBuilder builder) cil managed" />
 <MemberSignatureLanguage="DocId"Value="M:Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)" />
 <MemberSignatureLanguage="VB.NET"Value="Public Function Build (builder As IConfigurationBuilder) As IConfigurationProvider" />
 <MemberSignatureLanguage="F#"Value="abstract member Build : Microsoft.Extensions.Configuration.IConfigurationBuilder -&gt; Microsoft.Extensions.Configuration.IConfigurationProvider&#xA;override this.Build : Microsoft.Extensions.Configuration.IConfigurationBuilder -&gt; Microsoft.Extensions.Configuration.IConfigurationProvider"Usage="keyPerFileConfigurationSource.Build builder" />
 <MemberSignatureLanguage="C++ CLI"Value="public:&#xA; virtual Microsoft::Extensions::Configuration::IConfigurationProvider ^ Build(Microsoft::Extensions::Configuration::IConfigurationBuilder ^ builder);" />
 <MemberType>Method</MemberType>
 <Implements>
 <InterfaceMember>M:Microsoft.Extensions.Configuration.IConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)</InterfaceMember>
 </Implements>
 <AssemblyInfo>
 <AssemblyName>Microsoft.Extensions.Configuration.KeyPerFile</AssemblyName>
 <AssemblyVersion>10.0.0.0</AssemblyVersion>
 </AssemblyInfo>
 <ReturnValue>
 <ReturnType>Microsoft.Extensions.Configuration.IConfigurationProvider</ReturnType>
 </ReturnValue>
 <Parameters>
 <ParameterName="builder"Type="Microsoft.Extensions.Configuration.IConfigurationBuilder" />
 </Parameters>
 <Docs>
 <paramname="builder">The <seecref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder" />.</param>
 <summary>
 Builds the <seecref="T:Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationProvider" /> for this source.
 </summary>
 <returns>A <seecref="T:Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationProvider" /></returns>
 <remarks>To be added.</remarks>
 </Docs>
 </Member>
 <MemberMemberName="FileProvider">
 <MemberSignatureLanguage="C#"Value="public Microsoft.Extensions.FileProviders.IFileProvider? FileProvider { get; set; }" />
 <MemberSignatureLanguage="ILAsm"Value=".property instance class Microsoft.Extensions.FileProviders.IFileProvider FileProvider" />
 <MemberSignatureLanguage="DocId"Value="P:Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.FileProvider" />
 <MemberSignatureLanguage="VB.NET"Value="Public Property FileProvider As IFileProvider" />
 <MemberSignatureLanguage="F#"Value="member this.FileProvider : Microsoft.Extensions.FileProviders.IFileProvider with get, set"Usage="Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.FileProvider" />
 <MemberSignatureLanguage="C++ CLI"Value="public:&#xA; property Microsoft::Extensions::FileProviders::IFileProvider ^ FileProvider { Microsoft::Extensions::FileProviders::IFileProvider ^ get(); void set(Microsoft::Extensions::FileProviders::IFileProvider ^ value); };" />
 <MemberType>Property</MemberType>
 <AssemblyInfo>
 <AssemblyName>Microsoft.Extensions.Configuration.KeyPerFile</AssemblyName>
 <AssemblyVersion>10.0.0.0</AssemblyVersion>
 </AssemblyInfo>
 <Attributes>
 <AttributeFrameworkAlternate="net-10.0-pp">
 <AttributeNameLanguage="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
 <AttributeNameLanguage="F#">[&lt;System.Runtime.CompilerServices.Nullable(2)&gt;]</AttributeName>
 </Attribute>
 </Attributes>
 <ReturnValue>
 <ReturnType>Microsoft.Extensions.FileProviders.IFileProvider</ReturnType>
 </ReturnValue>
 <Docs>
 <summary>
 The FileProvider whos root "/" directory files will be used as configuration data.
 </summary>
 <value>To be added.</value>
 <remarks>To be added.</remarks>
 </Docs>
 </Member>
 <MemberMemberName="IgnoreCondition">
 <MemberSignatureLanguage="C#"Value="public Func&lt;string,bool&gt; IgnoreCondition { get; set; }" />
 <MemberSignatureLanguage="ILAsm"Value=".property instance class System.Func`2&lt;string, bool&gt; IgnoreCondition" />
 <MemberSignatureLanguage="DocId"Value="P:Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.IgnoreCondition" />
 <MemberSignatureLanguage="VB.NET"Value="Public Property IgnoreCondition As Func(Of String, Boolean)" />
 <MemberSignatureLanguage="F#"Value="member this.IgnoreCondition : Func&lt;string, bool&gt; with get, set"Usage="Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.IgnoreCondition" />
 <MemberSignatureLanguage="C++ CLI"Value="public:&#xA; property Func&lt;System::String ^, bool&gt; ^ IgnoreCondition { Func&lt;System::String ^, bool&gt; ^ get(); void set(Func&lt;System::String ^, bool&gt; ^ value); };" />
 <MemberType>Property</MemberType>
 <AssemblyInfo>
 <AssemblyName>Microsoft.Extensions.Configuration.KeyPerFile</AssemblyName>
 <AssemblyVersion>10.0.0.0</AssemblyVersion>
 </AssemblyInfo>
 <ReturnValue>
 <ReturnType>System.Func&lt;System.String,System.Boolean&gt;</ReturnType>
 </ReturnValue>
 <Docs>
 <summary>
 Used to determine if a file should be ignored using its name.
 Defaults to using the IgnorePrefix.
 </summary>
 <value>The default is to use <seecref="P:Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.IgnorePrefix" />.</value>
 <remarks>To be added.</remarks>
 </Docs>
 </Member>
 <MemberMemberName="IgnorePrefix">
 <MemberSignatureLanguage="C#"Value="public string IgnorePrefix { get; set; }" />
 <MemberSignatureLanguage="ILAsm"Value=".property instance string IgnorePrefix" />
 <MemberSignatureLanguage="DocId"Value="P:Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.IgnorePrefix" />
 <MemberSignatureLanguage="VB.NET"Value="Public Property IgnorePrefix As String" />
 <MemberSignatureLanguage="F#"Value="member this.IgnorePrefix : string with get, set"Usage="Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.IgnorePrefix" />
 <MemberSignatureLanguage="C++ CLI"Value="public:&#xA; property System::String ^ IgnorePrefix { System::String ^ get(); void set(System::String ^ value); };" />
 <MemberType>Property</MemberType>
 <AssemblyInfo>
 <AssemblyName>Microsoft.Extensions.Configuration.KeyPerFile</AssemblyName>
 <AssemblyVersion>10.0.0.0</AssemblyVersion>
 </AssemblyInfo>
 <ReturnValue>
 <ReturnType>System.String</ReturnType>
 </ReturnValue>
 <Docs>
 <summary>
 Files that start with this prefix will be excluded.
 Defaults to "ignore.".
 </summary>
 <value>The default is "ignore.".</value>
 <remarks>To be added.</remarks>
 </Docs>
 </Member>
 <MemberMemberName="Optional">
 <MemberSignatureLanguage="C#"Value="public bool Optional { get; set; }" />
 <MemberSignatureLanguage="ILAsm"Value=".property instance bool Optional" />
 <MemberSignatureLanguage="DocId"Value="P:Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.Optional" />
 <MemberSignatureLanguage="VB.NET"Value="Public Property Optional As Boolean" />
 <MemberSignatureLanguage="F#"Value="member this.Optional : bool with get, set"Usage="Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.Optional" />
 <MemberSignatureLanguage="C++ CLI"Value="public:&#xA; property bool Optional { bool get(); void set(bool value); };" />
 <MemberType>Property</MemberType>
 <AssemblyInfo>
 <AssemblyName>Microsoft.Extensions.Configuration.KeyPerFile</AssemblyName>
 <AssemblyVersion>10.0.0.0</AssemblyVersion>
 </AssemblyInfo>
 <ReturnValue>
 <ReturnType>System.Boolean</ReturnType>
 </ReturnValue>
 <Docs>
 <summary>
 If false, will throw if the directory doesn't exist.
 </summary>
 <value>To be added.</value>
 <remarks>To be added.</remarks>
 </Docs>
 </Member>
 <MemberMemberName="ReloadDelay">
 <MemberSignatureLanguage="C#"Value="public int ReloadDelay { get; set; }" />
 <MemberSignatureLanguage="ILAsm"Value=".property instance int32 ReloadDelay" />
 <MemberSignatureLanguage="DocId"Value="P:Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.ReloadDelay" />
 <MemberSignatureLanguage="VB.NET"Value="Public Property ReloadDelay As Integer" />
 <MemberSignatureLanguage="F#"Value="member this.ReloadDelay : int with get, set"Usage="Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.ReloadDelay" />
 <MemberSignatureLanguage="C++ CLI"Value="public:&#xA; property int ReloadDelay { int get(); void set(int value); };" />
 <MemberType>Property</MemberType>
 <AssemblyInfo>
 <AssemblyName>Microsoft.Extensions.Configuration.KeyPerFile</AssemblyName>
 <AssemblyVersion>10.0.0.0</AssemblyVersion>
 </AssemblyInfo>
 <ReturnValue>
 <ReturnType>System.Int32</ReturnType>
 </ReturnValue>
 <Docs>
 <summary>
 Number of milliseconds that reload will wait before calling Load. This helps
 avoid triggering reload before a file is completely written. Default is 250.
 </summary>
 <value>To be added.</value>
 <remarks>To be added.</remarks>
 </Docs>
 </Member>
 <MemberMemberName="ReloadOnChange">
 <MemberSignatureLanguage="C#"Value="public bool ReloadOnChange { get; set; }" />
 <MemberSignatureLanguage="ILAsm"Value=".property instance bool ReloadOnChange" />
 <MemberSignatureLanguage="DocId"Value="P:Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.ReloadOnChange" />
 <MemberSignatureLanguage="VB.NET"Value="Public Property ReloadOnChange As Boolean" />
 <MemberSignatureLanguage="F#"Value="member this.ReloadOnChange : bool with get, set"Usage="Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.ReloadOnChange" />
 <MemberSignatureLanguage="C++ CLI"Value="public:&#xA; property bool ReloadOnChange { bool get(); void set(bool value); };" />
 <MemberType>Property</MemberType>
 <AssemblyInfo>
 <AssemblyName>Microsoft.Extensions.Configuration.KeyPerFile</AssemblyName>
 <AssemblyVersion>10.0.0.0</AssemblyVersion>
 </AssemblyInfo>
 <ReturnValue>
 <ReturnType>System.Boolean</ReturnType>
 </ReturnValue>
 <Docs>
 <summary>
 Determines whether the source will be loaded if the underlying file changes.
 </summary>
 <value>To be added.</value>
 <remarks>To be added.</remarks>
 </Docs>
 </Member>
 <MemberMemberName="SectionDelimiter">
 <MemberSignatureLanguage="C#"Value="public string SectionDelimiter { get; set; }" />
 <MemberSignatureLanguage="ILAsm"Value=".property instance string SectionDelimiter" />
 <MemberSignatureLanguage="DocId"Value="P:Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.SectionDelimiter" />
 <MemberSignatureLanguage="VB.NET"Value="Public Property SectionDelimiter As String" />
 <MemberSignatureLanguage="F#"Value="member this.SectionDelimiter : string with get, set"Usage="Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.SectionDelimiter" />
 <MemberSignatureLanguage="C++ CLI"Value="public:&#xA; property System::String ^ SectionDelimiter { System::String ^ get(); void set(System::String ^ value); };" />
 <MemberType>Property</MemberType>
 <AssemblyInfo>
 <AssemblyName>Microsoft.Extensions.Configuration.KeyPerFile</AssemblyName>
 <AssemblyVersion>10.0.0.0</AssemblyVersion>
 </AssemblyInfo>
 <ReturnValue>
 <ReturnType>System.String</ReturnType>
 </ReturnValue>
 <Docs>
 <summary>
 The delimiter used to separate individual keys in a path.
 </summary>
 <value>Default is <c>__</c>.</value>
 <remarks>To be added.</remarks>
 </Docs>
 </Member>
 </Members>
</Type>