TimeZoneConverter.xml 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>TimeZoneConverter</name>
  5. </assembly>
  6. <members>
  7. <member name="T:TimeZoneConverter.TZConvert">
  8. <summary>
  9. Converts time zone identifiers from various sources.
  10. </summary>
  11. </member>
  12. <member name="P:TimeZoneConverter.TZConvert.KnownIanaTimeZoneNames">
  13. <summary>
  14. Gets a collection of all IANA time zone names known to this library.
  15. </summary>
  16. </member>
  17. <member name="P:TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds">
  18. <summary>
  19. Gets a collection of all Windows time zone IDs known to this library.
  20. </summary>
  21. </member>
  22. <member name="P:TimeZoneConverter.TZConvert.KnownRailsTimeZoneNames">
  23. <summary>
  24. Gets a collection of all Rails time zone names known to this library.
  25. </summary>
  26. </member>
  27. <member name="M:TimeZoneConverter.TZConvert.IanaToWindows(System.String)">
  28. <summary>
  29. Converts an IANA time zone name to the equivalent Windows time zone ID.
  30. </summary>
  31. <param name="ianaTimeZoneName">The IANA time zone name to convert.</param>
  32. <returns>A Windows time zone ID.</returns>
  33. <exception cref="T:System.InvalidTimeZoneException">Thrown if the input string was not recognized or has no equivalent Windows zone.</exception>
  34. </member>
  35. <member name="M:TimeZoneConverter.TZConvert.TryIanaToWindows(System.String,System.String@)">
  36. <summary>
  37. Attempts to convert an IANA time zone name to the equivalent Windows time zone ID.
  38. </summary>
  39. <param name="ianaTimeZoneName">The IANA time zone name to convert.</param>
  40. <param name="windowsTimeZoneId">A Windows time zone ID.</param>
  41. <returns><c>true</c> if successful, <c>false</c> otherwise.</returns>
  42. </member>
  43. <member name="M:TimeZoneConverter.TZConvert.WindowsToIana(System.String,System.String)">
  44. <summary>
  45. Converts a Windows time zone ID to an equivalent IANA time zone name.
  46. </summary>
  47. <param name="windowsTimeZoneId">The Windows time zone ID to convert.</param>
  48. <param name="territoryCode">
  49. An optional two-letter ISO Country/Region code, used to get a a specific mapping.
  50. Defaults to "001" if not specified, which means to get the "golden zone" - the one that is most prevalent.
  51. </param>
  52. <returns>An IANA time zone name.</returns>
  53. <exception cref="T:System.InvalidTimeZoneException">Thrown if the input string was not recognized or has no equivalent IANA zone.</exception>
  54. </member>
  55. <member name="M:TimeZoneConverter.TZConvert.TryWindowsToIana(System.String,System.String@)">
  56. <summary>
  57. Attempts to convert a Windows time zone ID to an equivalent IANA time zone name.
  58. Uses the "golden zone" - the one that is the most prevalent.
  59. </summary>
  60. <param name="windowsTimeZoneId">The Windows time zone ID to convert.</param>
  61. <param name="ianaTimeZoneName">An IANA time zone name.</param>
  62. <returns><c>true</c> if successful, <c>false</c> otherwise.</returns>
  63. </member>
  64. <member name="M:TimeZoneConverter.TZConvert.TryWindowsToIana(System.String,System.String,System.String@)">
  65. <summary>
  66. Attempts to convert a Windows time zone ID to an equivalent IANA time zone name.
  67. </summary>
  68. <param name="windowsTimeZoneId">The Windows time zone ID to convert.</param>
  69. <param name="territoryCode">
  70. An optional two-letter ISO Country/Region code, used to get a a specific mapping.
  71. Defaults to "001" if not specified, which means to get the "golden zone" - the one that is most prevalent.
  72. </param>
  73. <param name="ianaTimeZoneName">An IANA time zone name.</param>
  74. <returns><c>true</c> if successful, <c>false</c> otherwise.</returns>
  75. </member>
  76. <member name="M:TimeZoneConverter.TZConvert.GetTimeZoneInfo(System.String)">
  77. <summary>
  78. Retrieves a <see cref="T:System.TimeZoneInfo"/> object given a valid Windows or IANA time zone identifier,
  79. regardless of which platform the application is running on.
  80. </summary>
  81. <param name="windowsOrIanaTimeZoneId">A valid Windows or IANA time zone identifier.</param>
  82. <returns>A <see cref="T:System.TimeZoneInfo"/> object.</returns>
  83. </member>
  84. <member name="M:TimeZoneConverter.TZConvert.TryGetTimeZoneInfo(System.String,System.TimeZoneInfo@)">
  85. <summary>
  86. Attempts to retrieve a <see cref="T:System.TimeZoneInfo"/> object given a valid Windows or IANA time zone identifier,
  87. regardless of which platform the application is running on.
  88. </summary>
  89. <param name="windowsOrIanaTimeZoneId">A valid Windows or IANA time zone identifier.</param>
  90. <param name="timeZoneInfo">A <see cref="T:System.TimeZoneInfo"/> object.</param>
  91. <returns><c>true</c> if successful, <c>false</c> otherwise.</returns>
  92. </member>
  93. <member name="M:TimeZoneConverter.TZConvert.IanaToRails(System.String)">
  94. <summary>
  95. Converts an IANA time zone name to one or more equivalent Rails time zone names.
  96. </summary>
  97. <param name="ianaTimeZoneName">The IANA time zone name to convert.</param>
  98. <returns>One or more equivalent Rails time zone names.</returns>
  99. <exception cref="T:System.InvalidTimeZoneException">Thrown if the input string was not recognized or has no equivalent Rails zone.</exception>
  100. </member>
  101. <member name="M:TimeZoneConverter.TZConvert.TryIanaToRails(System.String,System.Collections.Generic.IList{System.String}@)">
  102. <summary>
  103. Attempts to convert an IANA time zone name to one or more equivalent Rails time zone names.
  104. </summary>
  105. <param name="ianaTimeZoneName">The IANA time zone name to convert.</param>
  106. <param name="railsTimeZoneNames">One or more equivalent Rails time zone names.</param>
  107. <returns><c>true</c> if successful, <c>false</c> otherwise.</returns>
  108. </member>
  109. <member name="M:TimeZoneConverter.TZConvert.RailsToIana(System.String)">
  110. <summary>
  111. Converts a Rails time zone name to an equivalent IANA time zone name.
  112. </summary>
  113. <param name="railsTimeZoneName">The Rails time zone name to convert.</param>
  114. <returns>An IANA time zone name.</returns>
  115. <exception cref="T:System.InvalidTimeZoneException">Thrown if the input string was not recognized or has no equivalent IANA zone.</exception>
  116. </member>
  117. <member name="M:TimeZoneConverter.TZConvert.TryRailsToIana(System.String,System.String@)">
  118. <summary>
  119. Attempts to convert a Rails time zone name to an equivalent IANA time zone name.
  120. </summary>
  121. <param name="railsTimeZoneName">The Rails time zone name to convert.</param>
  122. <param name="ianaTimeZoneName">An IANA time zone name.</param>
  123. <returns><c>true</c> if successful, <c>false</c> otherwise.</returns>
  124. </member>
  125. <member name="M:TimeZoneConverter.TZConvert.RailsToWindows(System.String)">
  126. <summary>
  127. Converts a Rails time zone name to an equivalent Windows time zone ID.
  128. </summary>
  129. <param name="railsTimeZoneName">The Rails time zone name to convert.</param>
  130. <returns>A Windows time zone ID.</returns>
  131. <exception cref="T:System.InvalidTimeZoneException">Thrown if the input string was not recognized or has no equivalent Windows zone.</exception>
  132. </member>
  133. <member name="M:TimeZoneConverter.TZConvert.TryRailsToWindows(System.String,System.String@)">
  134. <summary>
  135. Attempts to convert a Rails time zone name to an equivalent Windows time zone ID.
  136. </summary>
  137. <param name="railsTimeZoneName">The Rails time zone name to convert.</param>
  138. <param name="windowsTimeZoneId">A Windows time zone ID.</param>
  139. <returns><c>true</c> if successful, <c>false</c> otherwise.</returns>
  140. </member>
  141. <member name="M:TimeZoneConverter.TZConvert.WindowsToRails(System.String,System.String)">
  142. <summary>
  143. Converts a Windows time zone ID to one ore more equivalent Rails time zone names.
  144. </summary>
  145. <param name="windowsTimeZoneId">The Windows time zone ID to convert.</param>
  146. <param name="territoryCode">
  147. An optional two-letter ISO Country/Region code, used to get a a specific mapping.
  148. Defaults to "001" if not specified, which means to get the "golden zone" - the one that is most prevalent.
  149. </param>
  150. <returns>One or more equivalent Rails time zone names.</returns>
  151. <exception cref="T:System.InvalidTimeZoneException">Thrown if the input string was not recognized or has no equivalent Rails zone.</exception>
  152. </member>
  153. <member name="M:TimeZoneConverter.TZConvert.TryWindowsToRails(System.String,System.Collections.Generic.IList{System.String}@)">
  154. <summary>
  155. Attempts to convert a Windows time zone ID to one ore more equivalent Rails time zone names.
  156. Uses the "golden zone" - the one that is the most prevalent.
  157. </summary>
  158. <param name="windowsTimeZoneId">The Windows time zone ID to convert.</param>
  159. <param name="railsTimeZoneNames">One or more equivalent Rails time zone names.</param>
  160. <returns><c>true</c> if successful, <c>false</c> otherwise.</returns>
  161. </member>
  162. <member name="M:TimeZoneConverter.TZConvert.TryWindowsToRails(System.String,System.String,System.Collections.Generic.IList{System.String}@)">
  163. <summary>
  164. Attempts to convert a Windows time zone ID to one ore more equivalent Rails time zone names.
  165. </summary>
  166. <param name="windowsTimeZoneId">The Windows time zone ID to convert.</param>
  167. <param name="territoryCode">
  168. An optional two-letter ISO Country/Region code, used to get a a specific mapping.
  169. Defaults to "001" if not specified, which means to get the "golden zone" - the one that is most prevalent.
  170. </param>
  171. <param name="railsTimeZoneNames">One or more equivalent Rails time zone names.</param>
  172. <returns><c>true</c> if successful, <c>false</c> otherwise.</returns>
  173. </member>
  174. </members>
  175. </doc>