Microsoft.Extensions.Configuration.Binder.xml 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157
  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="T:Microsoft.Extensions.Configuration.ConfigurationBinder">
  19. <summary>
  20. Static helper class that allows binding strongly typed objects to configuration values.
  21. </summary>
  22. </member>
  23. <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get``1(Microsoft.Extensions.Configuration.IConfiguration)">
  24. <summary>
  25. Attempts to bind the configuration instance to a new instance of type T.
  26. If this configuration section has a value, that will be used.
  27. Otherwise binding by matching property names against configuration keys recursively.
  28. </summary>
  29. <typeparam name="T">The type of the new instance to bind.</typeparam>
  30. <param name="configuration">The configuration instance to bind.</param>
  31. <returns>The new instance of T if successful, default(T) otherwise.</returns>
  32. </member>
  33. <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get``1(Microsoft.Extensions.Configuration.IConfiguration,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
  34. <summary>
  35. Attempts to bind the configuration instance to a new instance of type T.
  36. If this configuration section has a value, that will be used.
  37. Otherwise binding by matching property names against configuration keys recursively.
  38. </summary>
  39. <typeparam name="T">The type of the new instance to bind.</typeparam>
  40. <param name="configuration">The configuration instance to bind.</param>
  41. <param name="configureOptions">Configures the binder options.</param>
  42. <returns>The new instance of T if successful, default(T) otherwise.</returns>
  43. </member>
  44. <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get(Microsoft.Extensions.Configuration.IConfiguration,System.Type)">
  45. <summary>
  46. Attempts to bind the configuration instance to a new instance of type T.
  47. If this configuration section has a value, that will be used.
  48. Otherwise binding by matching property names against configuration keys recursively.
  49. </summary>
  50. <param name="configuration">The configuration instance to bind.</param>
  51. <param name="type">The type of the new instance to bind.</param>
  52. <returns>The new instance if successful, null otherwise.</returns>
  53. </member>
  54. <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
  55. <summary>
  56. Attempts to bind the configuration instance to a new instance of type T.
  57. If this configuration section has a value, that will be used.
  58. Otherwise binding by matching property names against configuration keys recursively.
  59. </summary>
  60. <param name="configuration">The configuration instance to bind.</param>
  61. <param name="type">The type of the new instance to bind.</param>
  62. <param name="configureOptions">Configures the binder options.</param>
  63. <returns>The new instance if successful, null otherwise.</returns>
  64. </member>
  65. <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.String,System.Object)">
  66. <summary>
  67. Attempts to bind the given object instance to the configuration section specified by the key by matching property names against configuration keys recursively.
  68. </summary>
  69. <param name="configuration">The configuration instance to bind.</param>
  70. <param name="key">The key of the configuration section to bind.</param>
  71. <param name="instance">The object to bind.</param>
  72. </member>
  73. <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.Object)">
  74. <summary>
  75. Attempts to bind the given object instance to configuration values by matching property names against configuration keys recursively.
  76. </summary>
  77. <param name="configuration">The configuration instance to bind.</param>
  78. <param name="instance">The object to bind.</param>
  79. </member>
  80. <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.Object,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
  81. <summary>
  82. Attempts to bind the given object instance to configuration values by matching property names against configuration keys recursively.
  83. </summary>
  84. <param name="configuration">The configuration instance to bind.</param>
  85. <param name="instance">The object to bind.</param>
  86. <param name="configureOptions">Configures the binder options.</param>
  87. </member>
  88. <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue``1(Microsoft.Extensions.Configuration.IConfiguration,System.String)">
  89. <summary>
  90. Extracts the value with the specified key and converts it to type T.
  91. </summary>
  92. <typeparam name="T">The type to convert the value to.</typeparam>
  93. <param name="configuration">The configuration.</param>
  94. <param name="key">The key of the configuration section's value to convert.</param>
  95. <returns>The converted value.</returns>
  96. </member>
  97. <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue``1(Microsoft.Extensions.Configuration.IConfiguration,System.String,``0)">
  98. <summary>
  99. Extracts the value with the specified key and converts it to type T.
  100. </summary>
  101. <typeparam name="T">The type to convert the value to.</typeparam>
  102. <param name="configuration">The configuration.</param>
  103. <param name="key">The key of the configuration section's value to convert.</param>
  104. <param name="defaultValue">The default value to use if no value is found.</param>
  105. <returns>The converted value.</returns>
  106. </member>
  107. <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.String)">
  108. <summary>
  109. Extracts the value with the specified key and converts it to the specified type.
  110. </summary>
  111. <param name="configuration">The configuration.</param>
  112. <param name="type">The type to convert the value to.</param>
  113. <param name="key">The key of the configuration section's value to convert.</param>
  114. <returns>The converted value.</returns>
  115. </member>
  116. <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.String,System.Object)">
  117. <summary>
  118. Extracts the value with the specified key and converts it to the specified type.
  119. </summary>
  120. <param name="configuration">The configuration.</param>
  121. <param name="type">The type to convert the value to.</param>
  122. <param name="key">The key of the configuration section's value to convert.</param>
  123. <param name="defaultValue">The default value to use if no value is found.</param>
  124. <returns>The converted value.</returns>
  125. </member>
  126. <member name="P:Microsoft.Extensions.Configuration.Binder.Resources.Error_CannotActivateAbstractOrInterface">
  127. <summary>Cannot create instance of type '{0}' because it is either abstract or an interface.</summary>
  128. </member>
  129. <member name="M:Microsoft.Extensions.Configuration.Binder.Resources.FormatError_CannotActivateAbstractOrInterface(System.Object)">
  130. <summary>Cannot create instance of type '{0}' because it is either abstract or an interface.</summary>
  131. </member>
  132. <member name="P:Microsoft.Extensions.Configuration.Binder.Resources.Error_FailedBinding">
  133. <summary>Failed to convert configuration value at '{0}' to type '{1}'.</summary>
  134. </member>
  135. <member name="M:Microsoft.Extensions.Configuration.Binder.Resources.FormatError_FailedBinding(System.Object,System.Object)">
  136. <summary>Failed to convert configuration value at '{0}' to type '{1}'.</summary>
  137. </member>
  138. <member name="P:Microsoft.Extensions.Configuration.Binder.Resources.Error_FailedToActivate">
  139. <summary>Failed to create instance of type '{0}'.</summary>
  140. </member>
  141. <member name="M:Microsoft.Extensions.Configuration.Binder.Resources.FormatError_FailedToActivate(System.Object)">
  142. <summary>Failed to create instance of type '{0}'.</summary>
  143. </member>
  144. <member name="P:Microsoft.Extensions.Configuration.Binder.Resources.Error_MissingParameterlessConstructor">
  145. <summary>Cannot create instance of type '{0}' because it is missing a public parameterless constructor.</summary>
  146. </member>
  147. <member name="M:Microsoft.Extensions.Configuration.Binder.Resources.FormatError_MissingParameterlessConstructor(System.Object)">
  148. <summary>Cannot create instance of type '{0}' because it is missing a public parameterless constructor.</summary>
  149. </member>
  150. <member name="P:Microsoft.Extensions.Configuration.Binder.Resources.Error_UnsupportedMultidimensionalArray">
  151. <summary>Cannot create instance of type '{0}' because multidimensional arrays are not supported.</summary>
  152. </member>
  153. <member name="M:Microsoft.Extensions.Configuration.Binder.Resources.FormatError_UnsupportedMultidimensionalArray(System.Object)">
  154. <summary>Cannot create instance of type '{0}' because multidimensional arrays are not supported.</summary>
  155. </member>
  156. </members>
  157. </doc>