1 <?xml version="1.0"?>
\r
4 <name>Microsoft.Extensions.Configuration.Binder</name>
\r
7 <member name="T:Microsoft.Extensions.Configuration.BinderOptions">
\r
9 Options class used by the <see cref="T:Microsoft.Extensions.Configuration.ConfigurationBinder"/>.
\r
12 <member name="P:Microsoft.Extensions.Configuration.BinderOptions.BindNonPublicProperties">
\r
14 When false (the default), the binder will only attempt to set public properties.
\r
15 If true, the binder will attempt to set all non read-only properties.
\r
18 <member name="T:Microsoft.Extensions.Configuration.ConfigurationBinder">
\r
20 Static helper class that allows binding strongly typed objects to configuration values.
\r
23 <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get``1(Microsoft.Extensions.Configuration.IConfiguration)">
\r
25 Attempts to bind the configuration instance to a new instance of type T.
\r
26 If this configuration section has a value, that will be used.
\r
27 Otherwise binding by matching property names against configuration keys recursively.
\r
29 <typeparam name="T">The type of the new instance to bind.</typeparam>
\r
30 <param name="configuration">The configuration instance to bind.</param>
\r
31 <returns>The new instance of T if successful, default(T) otherwise.</returns>
\r
33 <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get``1(Microsoft.Extensions.Configuration.IConfiguration,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
\r
35 Attempts to bind the configuration instance to a new instance of type T.
\r
36 If this configuration section has a value, that will be used.
\r
37 Otherwise binding by matching property names against configuration keys recursively.
\r
39 <typeparam name="T">The type of the new instance to bind.</typeparam>
\r
40 <param name="configuration">The configuration instance to bind.</param>
\r
41 <param name="configureOptions">Configures the binder options.</param>
\r
42 <returns>The new instance of T if successful, default(T) otherwise.</returns>
\r
44 <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get(Microsoft.Extensions.Configuration.IConfiguration,System.Type)">
\r
46 Attempts to bind the configuration instance to a new instance of type T.
\r
47 If this configuration section has a value, that will be used.
\r
48 Otherwise binding by matching property names against configuration keys recursively.
\r
50 <param name="configuration">The configuration instance to bind.</param>
\r
51 <param name="type">The type of the new instance to bind.</param>
\r
52 <returns>The new instance if successful, null otherwise.</returns>
\r
54 <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
\r
56 Attempts to bind the configuration instance to a new instance of type T.
\r
57 If this configuration section has a value, that will be used.
\r
58 Otherwise binding by matching property names against configuration keys recursively.
\r
60 <param name="configuration">The configuration instance to bind.</param>
\r
61 <param name="type">The type of the new instance to bind.</param>
\r
62 <param name="configureOptions">Configures the binder options.</param>
\r
63 <returns>The new instance if successful, null otherwise.</returns>
\r
65 <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.String,System.Object)">
\r
67 Attempts to bind the given object instance to the configuration section specified by the key by matching property names against configuration keys recursively.
\r
69 <param name="configuration">The configuration instance to bind.</param>
\r
70 <param name="key">The key of the configuration section to bind.</param>
\r
71 <param name="instance">The object to bind.</param>
\r
73 <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.Object)">
\r
75 Attempts to bind the given object instance to configuration values by matching property names against configuration keys recursively.
\r
77 <param name="configuration">The configuration instance to bind.</param>
\r
78 <param name="instance">The object to bind.</param>
\r
80 <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.Object,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
\r
82 Attempts to bind the given object instance to configuration values by matching property names against configuration keys recursively.
\r
84 <param name="configuration">The configuration instance to bind.</param>
\r
85 <param name="instance">The object to bind.</param>
\r
86 <param name="configureOptions">Configures the binder options.</param>
\r
88 <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue``1(Microsoft.Extensions.Configuration.IConfiguration,System.String)">
\r
90 Extracts the value with the specified key and converts it to type T.
\r
92 <typeparam name="T">The type to convert the value to.</typeparam>
\r
93 <param name="configuration">The configuration.</param>
\r
94 <param name="key">The key of the configuration section's value to convert.</param>
\r
95 <returns>The converted value.</returns>
\r
97 <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue``1(Microsoft.Extensions.Configuration.IConfiguration,System.String,``0)">
\r
99 Extracts the value with the specified key and converts it to type T.
\r
101 <typeparam name="T">The type to convert the value to.</typeparam>
\r
102 <param name="configuration">The configuration.</param>
\r
103 <param name="key">The key of the configuration section's value to convert.</param>
\r
104 <param name="defaultValue">The default value to use if no value is found.</param>
\r
105 <returns>The converted value.</returns>
\r
107 <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.String)">
\r
109 Extracts the value with the specified key and converts it to the specified type.
\r
111 <param name="configuration">The configuration.</param>
\r
112 <param name="type">The type to convert the value to.</param>
\r
113 <param name="key">The key of the configuration section's value to convert.</param>
\r
114 <returns>The converted value.</returns>
\r
116 <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.String,System.Object)">
\r
118 Extracts the value with the specified key and converts it to the specified type.
\r
120 <param name="configuration">The configuration.</param>
\r
121 <param name="type">The type to convert the value to.</param>
\r
122 <param name="key">The key of the configuration section's value to convert.</param>
\r
123 <param name="defaultValue">The default value to use if no value is found.</param>
\r
124 <returns>The converted value.</returns>
\r
126 <member name="P:Microsoft.Extensions.Configuration.Binder.Resources.Error_CannotActivateAbstractOrInterface">
\r
127 <summary>Cannot create instance of type '{0}' because it is either abstract or an interface.</summary>
\r
129 <member name="M:Microsoft.Extensions.Configuration.Binder.Resources.FormatError_CannotActivateAbstractOrInterface(System.Object)">
\r
130 <summary>Cannot create instance of type '{0}' because it is either abstract or an interface.</summary>
\r
132 <member name="P:Microsoft.Extensions.Configuration.Binder.Resources.Error_FailedBinding">
\r
133 <summary>Failed to convert configuration value at '{0}' to type '{1}'.</summary>
\r
135 <member name="M:Microsoft.Extensions.Configuration.Binder.Resources.FormatError_FailedBinding(System.Object,System.Object)">
\r
136 <summary>Failed to convert configuration value at '{0}' to type '{1}'.</summary>
\r
138 <member name="P:Microsoft.Extensions.Configuration.Binder.Resources.Error_FailedToActivate">
\r
139 <summary>Failed to create instance of type '{0}'.</summary>
\r
141 <member name="M:Microsoft.Extensions.Configuration.Binder.Resources.FormatError_FailedToActivate(System.Object)">
\r
142 <summary>Failed to create instance of type '{0}'.</summary>
\r
144 <member name="P:Microsoft.Extensions.Configuration.Binder.Resources.Error_MissingParameterlessConstructor">
\r
145 <summary>Cannot create instance of type '{0}' because it is missing a public parameterless constructor.</summary>
\r
147 <member name="M:Microsoft.Extensions.Configuration.Binder.Resources.FormatError_MissingParameterlessConstructor(System.Object)">
\r
148 <summary>Cannot create instance of type '{0}' because it is missing a public parameterless constructor.</summary>
\r
150 <member name="P:Microsoft.Extensions.Configuration.Binder.Resources.Error_UnsupportedMultidimensionalArray">
\r
151 <summary>Cannot create instance of type '{0}' because multidimensional arrays are not supported.</summary>
\r
153 <member name="M:Microsoft.Extensions.Configuration.Binder.Resources.FormatError_UnsupportedMultidimensionalArray(System.Object)">
\r
154 <summary>Cannot create instance of type '{0}' because multidimensional arrays are not supported.</summary>
\r