Microsoft.Extensions.Configuration.Binder.xml 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Extensions.Configuration.Binder</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.Extensions.Configuration.BinderOptions">
  8. <summary>
  9. Options class used by the <see cref="T:Microsoft.Extensions.Configuration.ConfigurationBinder"/>.
  10. </summary>
  11. </member>
  12. <member name="P:Microsoft.Extensions.Configuration.BinderOptions.BindNonPublicProperties">
  13. <summary>
  14. When false (the default), the binder will only attempt to set public properties.
  15. If true, the binder will attempt to set all non read-only properties.
  16. </summary>
  17. </member>
  18. <member name="P:Microsoft.Extensions.Configuration.BinderOptions.ErrorOnUnknownConfiguration">
  19. <summary>
  20. When false (the default), no exceptions are thrown when a configuration key is found for which the
  21. provided model object does not have an appropriate property which matches the key's name.
  22. When true, an <see cref="T:System.InvalidOperationException"/> is thrown with a description
  23. of the missing properties.
  24. </summary>
  25. </member>
  26. <member name="T:Microsoft.Extensions.Configuration.ConfigurationBinder">
  27. <summary>
  28. Static helper class that allows binding strongly typed objects to configuration values.
  29. </summary>
  30. </member>
  31. <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get``1(Microsoft.Extensions.Configuration.IConfiguration)">
  32. <summary>
  33. Attempts to bind the configuration instance to a new instance of type T.
  34. If this configuration section has a value, that will be used.
  35. Otherwise binding by matching property names against configuration keys recursively.
  36. </summary>
  37. <typeparam name="T">The type of the new instance to bind.</typeparam>
  38. <param name="configuration">The configuration instance to bind.</param>
  39. <returns>The new instance of T if successful, default(T) otherwise.</returns>
  40. </member>
  41. <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get``1(Microsoft.Extensions.Configuration.IConfiguration,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
  42. <summary>
  43. Attempts to bind the configuration instance to a new instance of type T.
  44. If this configuration section has a value, that will be used.
  45. Otherwise binding by matching property names against configuration keys recursively.
  46. </summary>
  47. <typeparam name="T">The type of the new instance to bind.</typeparam>
  48. <param name="configuration">The configuration instance to bind.</param>
  49. <param name="configureOptions">Configures the binder options.</param>
  50. <returns>The new instance of T if successful, default(T) otherwise.</returns>
  51. </member>
  52. <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get(Microsoft.Extensions.Configuration.IConfiguration,System.Type)">
  53. <summary>
  54. Attempts to bind the configuration instance to a new instance of type T.
  55. If this configuration section has a value, that will be used.
  56. Otherwise binding by matching property names against configuration keys recursively.
  57. </summary>
  58. <param name="configuration">The configuration instance to bind.</param>
  59. <param name="type">The type of the new instance to bind.</param>
  60. <returns>The new instance if successful, null otherwise.</returns>
  61. </member>
  62. <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
  63. <summary>
  64. Attempts to bind the configuration instance to a new instance of type T.
  65. If this configuration section has a value, that will be used.
  66. Otherwise binding by matching property names against configuration keys recursively.
  67. </summary>
  68. <param name="configuration">The configuration instance to bind.</param>
  69. <param name="type">The type of the new instance to bind.</param>
  70. <param name="configureOptions">Configures the binder options.</param>
  71. <returns>The new instance if successful, null otherwise.</returns>
  72. </member>
  73. <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.String,System.Object)">
  74. <summary>
  75. Attempts to bind the given object instance to the configuration section specified by the key by matching property names against configuration keys recursively.
  76. </summary>
  77. <param name="configuration">The configuration instance to bind.</param>
  78. <param name="key">The key of the configuration section to bind.</param>
  79. <param name="instance">The object to bind.</param>
  80. </member>
  81. <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.Object)">
  82. <summary>
  83. Attempts to bind the given object instance to configuration values by matching property names against configuration keys recursively.
  84. </summary>
  85. <param name="configuration">The configuration instance to bind.</param>
  86. <param name="instance">The object to bind.</param>
  87. </member>
  88. <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.Object,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
  89. <summary>
  90. Attempts to bind the given object instance to configuration values by matching property names against configuration keys recursively.
  91. </summary>
  92. <param name="configuration">The configuration instance to bind.</param>
  93. <param name="instance">The object to bind.</param>
  94. <param name="configureOptions">Configures the binder options.</param>
  95. </member>
  96. <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue``1(Microsoft.Extensions.Configuration.IConfiguration,System.String)">
  97. <summary>
  98. Extracts the value with the specified key and converts it to type T.
  99. </summary>
  100. <typeparam name="T">The type to convert the value to.</typeparam>
  101. <param name="configuration">The configuration.</param>
  102. <param name="key">The key of the configuration section's value to convert.</param>
  103. <returns>The converted value.</returns>
  104. </member>
  105. <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue``1(Microsoft.Extensions.Configuration.IConfiguration,System.String,``0)">
  106. <summary>
  107. Extracts the value with the specified key and converts it to type T.
  108. </summary>
  109. <typeparam name="T">The type to convert the value to.</typeparam>
  110. <param name="configuration">The configuration.</param>
  111. <param name="key">The key of the configuration section's value to convert.</param>
  112. <param name="defaultValue">The default value to use if no value is found.</param>
  113. <returns>The converted value.</returns>
  114. </member>
  115. <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.String)">
  116. <summary>
  117. Extracts the value with the specified key and converts it to the specified type.
  118. </summary>
  119. <param name="configuration">The configuration.</param>
  120. <param name="type">The type to convert the value to.</param>
  121. <param name="key">The key of the configuration section's value to convert.</param>
  122. <returns>The converted value.</returns>
  123. </member>
  124. <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.String,System.Object)">
  125. <summary>
  126. Extracts the value with the specified key and converts it to the specified type.
  127. </summary>
  128. <param name="configuration">The configuration.</param>
  129. <param name="type">The type to convert the value to.</param>
  130. <param name="key">The key of the configuration section's value to convert.</param>
  131. <param name="defaultValue">The default value to use if no value is found.</param>
  132. <returns>The converted value.</returns>
  133. </member>
  134. <member name="M:System.ThrowHelper.ThrowIfNull(System.Object,System.String)">
  135. <summary>Throws an <see cref="T:System.ArgumentNullException"/> if <paramref name="argument"/> is null.</summary>
  136. <param name="argument">The reference type argument to validate as non-null.</param>
  137. <param name="paramName">The name of the parameter with which <paramref name="argument"/> corresponds.</param>
  138. </member>
  139. <member name="P:System.SR.Error_CannotActivateAbstractOrInterface">
  140. <summary>Cannot create instance of type '{0}' because it is either abstract or an interface.</summary>
  141. </member>
  142. <member name="P:System.SR.Error_CannotBindToConstructorParameter">
  143. <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>
  144. </member>
  145. <member name="P:System.SR.Error_ConstructorParametersDoNotMatchProperties">
  146. <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>
  147. </member>
  148. <member name="P:System.SR.Error_FailedBinding">
  149. <summary>Failed to convert configuration value at '{0}' to type '{1}'.</summary>
  150. </member>
  151. <member name="P:System.SR.Error_FailedToActivate">
  152. <summary>Failed to create instance of type '{0}'.</summary>
  153. </member>
  154. <member name="P:System.SR.Error_MissingConfig">
  155. <summary>'{0}' was set on the provided {1}, but the following properties were not found on the instance of {2}: {3}</summary>
  156. </member>
  157. <member name="P:System.SR.Error_MissingPublicInstanceConstructor">
  158. <summary>Cannot create instance of type '{0}' because it is missing a public instance constructor.</summary>
  159. </member>
  160. <member name="P:System.SR.Error_MultipleParameterizedConstructors">
  161. <summary>Cannot create instance of type '{0}' because it has multiple public parameterized constructors.</summary>
  162. </member>
  163. <member name="P:System.SR.Error_ParameterBeingBoundToIsUnnamed">
  164. <summary>Cannot create instance of type '{0}' because one or more parameters are unnamed.</summary>
  165. </member>
  166. <member name="P:System.SR.Error_ParameterHasNoMatchingConfig">
  167. <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>
  168. </member>
  169. <member name="P:System.SR.Error_UnsupportedMultidimensionalArray">
  170. <summary>Cannot create instance of type '{0}' because multidimensional arrays are not supported.</summary>
  171. </member>
  172. </members>
  173. </doc>