203 lines
14 KiB
XML
203 lines
14 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>Microsoft.Extensions.Configuration.Binder</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:Microsoft.Extensions.Configuration.BinderOptions">
|
|
<summary>
|
|
Specifies options used by the <see cref="T:Microsoft.Extensions.Configuration.ConfigurationBinder"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Configuration.BinderOptions.BindNonPublicProperties">
|
|
<summary>
|
|
Gets or sets a value that indicates whether the binder attempts to set all properties or only public properties.
|
|
</summary>
|
|
<value>
|
|
<see langword="true" /> if the binder attempts to set all non-read-only properties; <see langword="false" /> if only public properties are set.
|
|
</value>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Configuration.BinderOptions.ErrorOnUnknownConfiguration">
|
|
<summary>
|
|
Gets or sets a value that indicates whether exceptions are thrown when converting a value or when a configuration
|
|
key is found for which the provided model object doesn't have an appropriate property that matches the key's name.
|
|
</summary>
|
|
<value>
|
|
<see langword="true" /> if an <see cref="T:System.InvalidOperationException"/> is thrown with a description; <see langword="false" /> if no exceptions are thrown. The default is <see langword="false" />.
|
|
</value>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Configuration.ConfigurationBinder">
|
|
<summary>
|
|
Static helper class that allows binding strongly typed objects to configuration values.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get``1(Microsoft.Extensions.Configuration.IConfiguration)">
|
|
<summary>
|
|
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.
|
|
</summary>
|
|
<typeparam name="T">The type of the new instance to bind.</typeparam>
|
|
<param name="configuration">The configuration instance to bind.</param>
|
|
<returns>The new instance of T if successful, default(T) otherwise.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get``1(Microsoft.Extensions.Configuration.IConfiguration,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
|
|
<summary>
|
|
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.
|
|
</summary>
|
|
<typeparam name="T">The type of the new instance to bind.</typeparam>
|
|
<param name="configuration">The configuration instance to bind.</param>
|
|
<param name="configureOptions">Configures the binder options.</param>
|
|
<returns>The new instance of T if successful, default(T) otherwise.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get(Microsoft.Extensions.Configuration.IConfiguration,System.Type)">
|
|
<summary>
|
|
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.
|
|
</summary>
|
|
<param name="configuration">The configuration instance to bind.</param>
|
|
<param name="type">The type of the new instance to bind.</param>
|
|
<returns>The new instance if successful, null otherwise.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
|
|
<summary>
|
|
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.
|
|
</summary>
|
|
<param name="configuration">The configuration instance to bind.</param>
|
|
<param name="type">The type of the new instance to bind.</param>
|
|
<param name="configureOptions">Configures the binder options.</param>
|
|
<returns>The new instance if successful, null otherwise.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.String,System.Object)">
|
|
<summary>
|
|
Attempts to bind the given object instance to the configuration section specified by the key by matching property names against configuration keys recursively.
|
|
</summary>
|
|
<param name="configuration">The configuration instance to bind.</param>
|
|
<param name="key">The key of the configuration section to bind.</param>
|
|
<param name="instance">The object to bind.</param>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.Object)">
|
|
<summary>
|
|
Attempts to bind the given object instance to configuration values by matching property names against configuration keys recursively.
|
|
</summary>
|
|
<param name="configuration">The configuration instance to bind.</param>
|
|
<param name="instance">The object to bind.</param>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.Object,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
|
|
<summary>
|
|
Attempts to bind the given object instance to configuration values by matching property names against configuration keys recursively.
|
|
</summary>
|
|
<param name="configuration">The configuration instance to bind.</param>
|
|
<param name="instance">The object to bind.</param>
|
|
<param name="configureOptions">Configures the binder options.</param>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue``1(Microsoft.Extensions.Configuration.IConfiguration,System.String)">
|
|
<summary>
|
|
Extracts the value with the specified key and converts it to type T.
|
|
</summary>
|
|
<typeparam name="T">The type to convert the value to.</typeparam>
|
|
<param name="configuration">The configuration.</param>
|
|
<param name="key">The key of the configuration section's value to convert.</param>
|
|
<returns>The converted value.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue``1(Microsoft.Extensions.Configuration.IConfiguration,System.String,``0)">
|
|
<summary>
|
|
Extracts the value with the specified key and converts it to type T.
|
|
</summary>
|
|
<typeparam name="T">The type to convert the value to.</typeparam>
|
|
<param name="configuration">The configuration.</param>
|
|
<param name="key">The key of the configuration section's value to convert.</param>
|
|
<param name="defaultValue">The default value to use if no value is found.</param>
|
|
<returns>The converted value.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.String)">
|
|
<summary>
|
|
Extracts the value with the specified key and converts it to the specified type.
|
|
</summary>
|
|
<param name="configuration">The configuration.</param>
|
|
<param name="type">The type to convert the value to.</param>
|
|
<param name="key">The key of the configuration section's value to convert.</param>
|
|
<returns>The converted value.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.String,System.Object)">
|
|
<summary>
|
|
Extracts the value with the specified key and converts it to the specified type.
|
|
</summary>
|
|
<param name="configuration">The configuration.</param>
|
|
<param name="type">The type to convert the value to.</param>
|
|
<param name="key">The key of the configuration section's value to convert.</param>
|
|
<param name="defaultValue">The default value to use if no value is found.</param>
|
|
<returns>The converted value.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.ResetPropertyValue(System.Reflection.PropertyInfo,System.Object,Microsoft.Extensions.Configuration.BinderOptions)">
|
|
<summary>
|
|
Reset the property value to the value from the property getter. This is useful for properties that have a getter or setters that perform some logic changing the object state.
|
|
</summary>
|
|
<param name="property">The property to reset.</param>
|
|
<param name="instance">The instance to reset the property on.</param>
|
|
<param name="options">The binder options.</param>
|
|
<remarks>
|
|
This method doesn't do any configuration binding. It just resets the property value to the value from the property getter.
|
|
This method called only when creating an instance using a primary constructor with parameters names match properties names.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.CreateInstance(System.Type,Microsoft.Extensions.Configuration.IConfiguration,Microsoft.Extensions.Configuration.BinderOptions,System.Reflection.ParameterInfo[]@)">
|
|
<summary>
|
|
Create an instance of the specified type.
|
|
</summary>
|
|
<param name="type">The type to create an instance of.</param>
|
|
<param name="config">The configuration to bind to the instance.</param>
|
|
<param name="options">The binder options.</param>
|
|
<param name="constructorParameters">The parameters of the constructor used to create the instance.</param>
|
|
<returns>The created instance.</returns>
|
|
<exception cref="T:System.InvalidOperationException">If the type cannot be created.</exception>
|
|
<remarks>
|
|
constructorParameters will not be null only when using a constructor with a parameters which get their values from the configuration
|
|
This happen when using types having properties match the constructor parameter names. `record` types are an example.
|
|
In such cases we need to carry the parameters list to avoid binding the properties again during BindProperties.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:System.SR.Error_CannotActivateAbstractOrInterface">
|
|
<summary>Cannot create instance of type '{0}' because it is either abstract or an interface.</summary>
|
|
</member>
|
|
<member name="P:System.SR.Error_CannotBindToConstructorParameter">
|
|
<summary>Cannot create instance of type '{0}' because one or more parameters cannot be bound to. Constructor parameters cannot be declared as in, out, or ref. Invalid parameters are: '{1}'</summary>
|
|
</member>
|
|
<member name="P:System.SR.Error_ConstructorParametersDoNotMatchProperties">
|
|
<summary>Cannot create instance of type '{0}' because one or more parameters cannot be bound to. Constructor parameters must have corresponding properties. Fields are not supported. Missing properties are: '{1}'</summary>
|
|
</member>
|
|
<member name="P:System.SR.Error_FailedBinding">
|
|
<summary>Failed to convert configuration value '{0}' at '{1}' to type '{2}'.</summary>
|
|
</member>
|
|
<member name="P:System.SR.Error_FailedToActivate">
|
|
<summary>Failed to create instance of type '{0}'.</summary>
|
|
</member>
|
|
<member name="P:System.SR.Error_GeneralErrorWhenBinding">
|
|
<summary>'{0}' was set and binding has failed. The likely cause is an invalid configuration value.</summary>
|
|
</member>
|
|
<member name="P:System.SR.Error_MissingConfig">
|
|
<summary>'{0}' was set on the provided {1}, but the following properties were not found on the instance of {2}: {3}</summary>
|
|
</member>
|
|
<member name="P:System.SR.Error_MissingPublicInstanceConstructor">
|
|
<summary>Cannot create instance of type '{0}' because it is missing a public instance constructor.</summary>
|
|
</member>
|
|
<member name="P:System.SR.Error_MultipleParameterizedConstructors">
|
|
<summary>Cannot create instance of type '{0}' because it has multiple public parameterized constructors.</summary>
|
|
</member>
|
|
<member name="P:System.SR.Error_ParameterBeingBoundToIsUnnamed">
|
|
<summary>Cannot create instance of type '{0}' because one or more parameters are unnamed.</summary>
|
|
</member>
|
|
<member name="P:System.SR.Error_ParameterHasNoMatchingConfig">
|
|
<summary>Cannot create instance of type '{0}' because parameter '{1}' has no matching config. Each parameter in the constructor that does not have a default value must have a corresponding config entry.</summary>
|
|
</member>
|
|
<member name="P:System.SR.Error_UnsupportedMultidimensionalArray">
|
|
<summary>Cannot create instance of type '{0}' because multidimensional arrays are not supported.</summary>
|
|
</member>
|
|
</members>
|
|
</doc>
|