Microsoft.Extensions.Localization.Abstractions.xml 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Extensions.Localization.Abstractions</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.Extensions.Localization.IStringLocalizer">
  8. <summary>
  9. Represents a service that provides localized strings.
  10. </summary>
  11. </member>
  12. <member name="P:Microsoft.Extensions.Localization.IStringLocalizer.Item(System.String)">
  13. <summary>
  14. Gets the string resource with the given name.
  15. </summary>
  16. <param name="name">The name of the string resource.</param>
  17. <returns>The string resource as a <see cref="T:Microsoft.Extensions.Localization.LocalizedString"/>.</returns>
  18. </member>
  19. <member name="P:Microsoft.Extensions.Localization.IStringLocalizer.Item(System.String,System.Object[])">
  20. <summary>
  21. Gets the string resource with the given name and formatted with the supplied arguments.
  22. </summary>
  23. <param name="name">The name of the string resource.</param>
  24. <param name="arguments">The values to format the string with.</param>
  25. <returns>The formatted string resource as a <see cref="T:Microsoft.Extensions.Localization.LocalizedString"/>.</returns>
  26. </member>
  27. <member name="M:Microsoft.Extensions.Localization.IStringLocalizer.GetAllStrings(System.Boolean)">
  28. <summary>
  29. Gets all string resources.
  30. </summary>
  31. <param name="includeParentCultures">
  32. A <see cref="T:System.Boolean"/> indicating whether to include strings from parent cultures.
  33. </param>
  34. <returns>The strings.</returns>
  35. </member>
  36. <member name="M:Microsoft.Extensions.Localization.IStringLocalizer.WithCulture(System.Globalization.CultureInfo)">
  37. <summary>
  38. Creates a new <see cref="T:Microsoft.Extensions.Localization.IStringLocalizer"/> for a specific <see cref="T:System.Globalization.CultureInfo"/>.
  39. </summary>
  40. <param name="culture">The <see cref="T:System.Globalization.CultureInfo"/> to use.</param>
  41. <returns>A culture-specific <see cref="T:Microsoft.Extensions.Localization.IStringLocalizer"/>.</returns>
  42. </member>
  43. <member name="T:Microsoft.Extensions.Localization.IStringLocalizerFactory">
  44. <summary>
  45. Represents a factory that creates <see cref="T:Microsoft.Extensions.Localization.IStringLocalizer"/> instances.
  46. </summary>
  47. </member>
  48. <member name="M:Microsoft.Extensions.Localization.IStringLocalizerFactory.Create(System.Type)">
  49. <summary>
  50. Creates an <see cref="T:Microsoft.Extensions.Localization.IStringLocalizer"/> using the <see cref="T:System.Reflection.Assembly"/> and
  51. <see cref="P:System.Type.FullName"/> of the specified <see cref="T:System.Type"/>.
  52. </summary>
  53. <param name="resourceSource">The <see cref="T:System.Type"/>.</param>
  54. <returns>The <see cref="T:Microsoft.Extensions.Localization.IStringLocalizer"/>.</returns>
  55. </member>
  56. <member name="M:Microsoft.Extensions.Localization.IStringLocalizerFactory.Create(System.String,System.String)">
  57. <summary>
  58. Creates an <see cref="T:Microsoft.Extensions.Localization.IStringLocalizer"/>.
  59. </summary>
  60. <param name="baseName">The base name of the resource to load strings from.</param>
  61. <param name="location">The location to load resources from.</param>
  62. <returns>The <see cref="T:Microsoft.Extensions.Localization.IStringLocalizer"/>.</returns>
  63. </member>
  64. <member name="T:Microsoft.Extensions.Localization.IStringLocalizer`1">
  65. <summary>
  66. Represents an <see cref="T:Microsoft.Extensions.Localization.IStringLocalizer"/> that provides strings for <typeparamref name="T"/>.
  67. </summary>
  68. <typeparam name="T">The <see cref="T:System.Type"/> to provide strings for.</typeparam>
  69. </member>
  70. <member name="T:Microsoft.Extensions.Localization.LocalizedString">
  71. <summary>
  72. A locale specific string.
  73. </summary>
  74. </member>
  75. <member name="M:Microsoft.Extensions.Localization.LocalizedString.#ctor(System.String,System.String)">
  76. <summary>
  77. Creates a new <see cref="T:Microsoft.Extensions.Localization.LocalizedString"/>.
  78. </summary>
  79. <param name="name">The name of the string in the resource it was loaded from.</param>
  80. <param name="value">The actual string.</param>
  81. </member>
  82. <member name="M:Microsoft.Extensions.Localization.LocalizedString.#ctor(System.String,System.String,System.Boolean)">
  83. <summary>
  84. Creates a new <see cref="T:Microsoft.Extensions.Localization.LocalizedString"/>.
  85. </summary>
  86. <param name="name">The name of the string in the resource it was loaded from.</param>
  87. <param name="value">The actual string.</param>
  88. <param name="resourceNotFound">Whether the string was not found in a resource. Set this to <c>true</c> to indicate an alternate string value was used.</param>
  89. </member>
  90. <member name="M:Microsoft.Extensions.Localization.LocalizedString.#ctor(System.String,System.String,System.Boolean,System.String)">
  91. <summary>
  92. Creates a new <see cref="T:Microsoft.Extensions.Localization.LocalizedString"/>.
  93. </summary>
  94. <param name="name">The name of the string in the resource it was loaded from.</param>
  95. <param name="value">The actual string.</param>
  96. <param name="resourceNotFound">Whether the string was not found in a resource. Set this to <c>true</c> to indicate an alternate string value was used.</param>
  97. <param name="searchedLocation">The location which was searched for a localization value.</param>
  98. </member>
  99. <member name="P:Microsoft.Extensions.Localization.LocalizedString.Name">
  100. <summary>
  101. The name of the string in the resource it was loaded from.
  102. </summary>
  103. </member>
  104. <member name="P:Microsoft.Extensions.Localization.LocalizedString.Value">
  105. <summary>
  106. The actual string.
  107. </summary>
  108. </member>
  109. <member name="P:Microsoft.Extensions.Localization.LocalizedString.ResourceNotFound">
  110. <summary>
  111. Whether the string was not found in a resource. If <c>true</c>, an alternate string value was used.
  112. </summary>
  113. </member>
  114. <member name="P:Microsoft.Extensions.Localization.LocalizedString.SearchedLocation">
  115. <summary>
  116. The location which was searched for a localization value.
  117. </summary>
  118. </member>
  119. <member name="M:Microsoft.Extensions.Localization.LocalizedString.ToString">
  120. <summary>
  121. Returns the actual string.
  122. </summary>
  123. <returns>The actual string.</returns>
  124. </member>
  125. <member name="M:Microsoft.Extensions.Localization.StringLocalizerExtensions.GetString(Microsoft.Extensions.Localization.IStringLocalizer,System.String)">
  126. <summary>
  127. Gets the string resource with the given name.
  128. </summary>
  129. <param name="stringLocalizer">The <see cref="T:Microsoft.Extensions.Localization.IStringLocalizer"/>.</param>
  130. <param name="name">The name of the string resource.</param>
  131. <returns>The string resource as a <see cref="T:Microsoft.Extensions.Localization.LocalizedString"/>.</returns>
  132. </member>
  133. <member name="M:Microsoft.Extensions.Localization.StringLocalizerExtensions.GetString(Microsoft.Extensions.Localization.IStringLocalizer,System.String,System.Object[])">
  134. <summary>
  135. Gets the string resource with the given name and formatted with the supplied arguments.
  136. </summary>
  137. <param name="stringLocalizer">The <see cref="T:Microsoft.Extensions.Localization.IStringLocalizer"/>.</param>
  138. <param name="name">The name of the string resource.</param>
  139. <param name="arguments">The values to format the string with.</param>
  140. <returns>The formatted string resource as a <see cref="T:Microsoft.Extensions.Localization.LocalizedString"/>.</returns>
  141. </member>
  142. <member name="M:Microsoft.Extensions.Localization.StringLocalizerExtensions.GetAllStrings(Microsoft.Extensions.Localization.IStringLocalizer)">
  143. <summary>
  144. Gets all string resources including those for parent cultures.
  145. </summary>
  146. <param name="stringLocalizer">The <see cref="T:Microsoft.Extensions.Localization.IStringLocalizer"/>.</param>
  147. <returns>The string resources.</returns>
  148. </member>
  149. <member name="T:Microsoft.Extensions.Localization.StringLocalizer`1">
  150. <summary>
  151. Provides strings for <typeparamref name="TResourceSource"/>.
  152. </summary>
  153. <typeparam name="TResourceSource">The <see cref="T:System.Type"/> to provide strings for.</typeparam>
  154. </member>
  155. <member name="M:Microsoft.Extensions.Localization.StringLocalizer`1.#ctor(Microsoft.Extensions.Localization.IStringLocalizerFactory)">
  156. <summary>
  157. Creates a new <see cref="T:Microsoft.Extensions.Localization.StringLocalizer`1"/>.
  158. </summary>
  159. <param name="factory">The <see cref="T:Microsoft.Extensions.Localization.IStringLocalizerFactory"/> to use.</param>
  160. </member>
  161. <member name="M:Microsoft.Extensions.Localization.StringLocalizer`1.WithCulture(System.Globalization.CultureInfo)">
  162. <inheritdoc />
  163. </member>
  164. <member name="P:Microsoft.Extensions.Localization.StringLocalizer`1.Item(System.String)">
  165. <inheritdoc />
  166. </member>
  167. <member name="P:Microsoft.Extensions.Localization.StringLocalizer`1.Item(System.String,System.Object[])">
  168. <inheritdoc />
  169. </member>
  170. <member name="M:Microsoft.Extensions.Localization.StringLocalizer`1.GetAllStrings(System.Boolean)">
  171. <inheritdoc />
  172. </member>
  173. </members>
  174. </doc>