Xamarin.Forms.Maps.xml 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455
  1. <doc>
  2. <assembly>
  3. <name>Xamarin.Forms.Maps</name>
  4. </assembly>
  5. <members>
  6. <member name="T:Xamarin.Forms.Maps.Distance">
  7. <summary>Struct that encapsulates a distance (natively stored as a double of meters).</summary>
  8. <remarks>To be added.</remarks>
  9. </member>
  10. <member name="C:Xamarin.Forms.Maps.Distance(System.Double)">
  11. <param name="meters">The distance value, in meters, with which to initialize a new <see cref="T:Xamarin.Forms.Maps.Distance" /> structure.</param>
  12. <summary>Creates a new <see cref="T:Xamarin.Forms.Maps.Distance" /> that represents the distance described by <paramref name="meters" />.</summary>
  13. <remarks>To be added.</remarks>
  14. </member>
  15. <member name="M:Xamarin.Forms.Maps.Distance.Equals(System.Object)">
  16. <param name="obj">An Object to compare to <c>this</c>.</param>
  17. <summary>Whether an <see cref="T:System.Object" /> is a <see cref="T:Xamarin.Forms.Maps.Distance" /> and has exactly the same values as <c>this</c><see cref="T:Xamarin.Forms.Maps.Distance" />.</summary>
  18. <returns>
  19. <see langword="true" /> if <paramref name="obj" /> is a <see cref="T:Xamarin.Forms.Maps.Distance" /> and has exactly the same values as <c>this</c><see cref="T:Xamarin.Forms.Maps.Distance" />.</returns>
  20. <remarks>To be added.</remarks>
  21. </member>
  22. <member name="M:Xamarin.Forms.Maps.Distance.Equals(Xamarin.Forms.Maps.Distance)">
  23. <param name="other">The <see cref="T:Xamarin.Forms.Maps.Distance" /> being compared to <c>this</c><see cref="T:Xamarin.Forms.Maps.Distance" />.</param>
  24. <summary>Whether a <see cref="T:Xamaring.Forms.Maps.Distance" /> has exactly the same values as <c>this </c><see cref="T:Xamaring.Forms.Maps.Distance" />.</summary>
  25. <returns>
  26. <see langword="true" /> if <paramref name="other" /> has exactly the same value as <c>this</c><see cref="T:Xamaring.Forms.Maps.Distance" />.</returns>
  27. <remarks>To be added.</remarks>
  28. </member>
  29. <member name="M:Xamarin.Forms.Maps.Distance.FromKilometers(System.Double)">
  30. <param name="kilometers">A double value representing the distance, in kilometers, for the <see cref="T:Xamarin.Forms.Maps.Distance" /> to create.</param>
  31. <summary>Factory method to create a <see cref="T:Xamarin.Forms.Maps.Distance" /> from a value provided in kilometers.</summary>
  32. <returns>To be added.</returns>
  33. <remarks>To be added.</remarks>
  34. </member>
  35. <member name="M:Xamarin.Forms.Maps.Distance.FromMeters(System.Double)">
  36. <param name="meters">A double value representing the distance, in meters, for the <see cref="T:Xamarin.Forms.Maps.Distance" /> to create.</param>
  37. <summary>Factory method to create a <see cref="T:Xamarin.Forms.Maps.Distance" /> from a value provided in meters.</summary>
  38. <returns>To be added.</returns>
  39. <remarks>To be added.</remarks>
  40. </member>
  41. <member name="M:Xamarin.Forms.Maps.Distance.FromMiles(System.Double)">
  42. <param name="miles">A double value representing the distance, in miles, for the <see cref="T:Xamarin.Forms.Maps.Distance" /> to create.</param>
  43. <summary>Factory method to create a <see cref="T:Xamarin.Forms.Maps.Distance" /> from a value provided in miles.</summary>
  44. <returns>To be added.</returns>
  45. <remarks>To be added.</remarks>
  46. </member>
  47. <member name="M:Xamarin.Forms.Maps.Distance.GetHashCode">
  48. <summary>The hashcode for the <see cref="T:Xamarin.Forms.Maps.Distance" />.</summary>
  49. <returns>A value optimized for fast insertion and retrieval in a hash-based data structure.</returns>
  50. <remarks>To be added.</remarks>
  51. </member>
  52. <member name="P:Xamarin.Forms.Maps.Distance.Kilometers">
  53. <summary>Gets the distance in kilometers that is spanned by <c>this</c><see cref="T:Xamarin.Forms.Maps.Distance" />.</summary>
  54. <value>The distance in kilometers that is spanned by <c>this</c><see cref="T:Xamarin.Forms.Maps.Distance" /></value>
  55. <remarks>To be added.</remarks>
  56. </member>
  57. <member name="P:Xamarin.Forms.Maps.Distance.Meters">
  58. <summary>Gets the distance in meters that is spanned by <c>this</c><see cref="T:Xamarin.Forms.Maps.Distance" />.</summary>
  59. <value>Toe distance in meters that is spanned by <c>this</c><see cref="T:Xamarin.Forms.Maps.Distance" />.</value>
  60. <remarks>To be added.</remarks>
  61. </member>
  62. <member name="P:Xamarin.Forms.Maps.Distance.Miles">
  63. <summary>Gets the distance in miles that is spanned by <c>this</c><see cref="T:Xamarin.Forms.Maps.Distance" />.</summary>
  64. <value>The distance in miles that is spanned by <c>this</c><see cref="T:Xamarin.Forms.Maps.Distance" />.</value>
  65. <remarks>To be added.</remarks>
  66. </member>
  67. <member name="M:Xamarin.Forms.Maps.Distance.op_Equality(Xamarin.Forms.Maps.Distance,Xamarin.Forms.Maps.Distance)">
  68. <param name="left">A <see cref="T:Xamarin.Forms.Maps.Distance" /> to compare to another <see cref="T:Xamarin.Forms.Maps.Distance" />.</param>
  69. <param name="right">A <see cref="T:Xamarin.Forms.Maps.Distance" /> to compare to <paramref name="left" />.</param>
  70. <summary>Whether two <see cref="T:Xamarin.Forms.Maps.Distance" />s have <see cref="P:Xamarin.Forms.Maps.Distance.Meters" /> properties that are exactly the same.</summary>
  71. <returns>
  72. <see langword="true" /> if <paramref name="left" /> and <paramref name="right" /> have identical <see cref="P:Xamarin.Forms.Maps.Distance.Meters" /> properties.</returns>
  73. <remarks>To be added.</remarks>
  74. </member>
  75. <member name="M:Xamarin.Forms.Maps.Distance.op_Inequality(Xamarin.Forms.Maps.Distance,Xamarin.Forms.Maps.Distance)">
  76. <param name="left">A <see cref="T:Xamarin.Forms.Maps.Distance" /> to compare to another <see cref="T:Xamarin.Forms.Maps.Distance" />.</param>
  77. <param name="right">A <see cref="T:Xamarin.Forms.Maps.Distance" /> to compare to <paramref name="left" />.</param>
  78. <summary>Whether two <see cref="T:Xamarin.Forms.Maps.Distance" />s have differing <see cref="P:Xamarin.Forms.Maps.Distance.Meters" /> properties.</summary>
  79. <returns>
  80. <see langword="true" /> if <paramref name="left" /> and <paramref name="right" /> have different <see cref="P:Xamarin.Forms.Maps.Distance.Meters" /> properties.</returns>
  81. <remarks>To be added.</remarks>
  82. </member>
  83. <member name="T:Xamarin.Forms.Maps.Geocoder">
  84. <summary>Converts between string addresses and <see cref="T:Xamarin.Forms.Maps.Position" />s.</summary>
  85. <remarks>To be added.</remarks>
  86. </member>
  87. <member name="C:Xamarin.Forms.Maps.Geocoder">
  88. <summary>Creates a new <see cref="T:Xamarin.Forms.Maps.Geocoder" /> object with default values.</summary>
  89. <remarks>To be added.</remarks>
  90. </member>
  91. <member name="M:Xamarin.Forms.Maps.Geocoder.GetAddressesForPositionAsync(Xamarin.Forms.Maps.Position)">
  92. <param name="position">To be added.</param>
  93. <summary>Returns the addresses near <paramref name="position" />, asynchronously.</summary>
  94. <returns>To be added.</returns>
  95. <remarks>To be added.</remarks>
  96. </member>
  97. <member name="M:Xamarin.Forms.Maps.Geocoder.GetPositionsForAddressAsync(System.String)">
  98. <param name="address">To be added.</param>
  99. <summary>Returns a list of positions for <paramref name="address" />.</summary>
  100. <returns>To be added.</returns>
  101. <remarks>To be added.</remarks>
  102. </member>
  103. <member name="T:Xamarin.Forms.Maps.Map">
  104. <summary>A <see cref="T:Xamarin.Forms.View" /> that shows a map provided by a platform-specific service.</summary>
  105. <remarks>
  106. <para>Here is a very simple example of a <see cref="T:Xamarin.Forms.Map" />:</para>
  107. <example>
  108. <code lang="C#"><![CDATA[
  109. var map = new Map (MapSpan.FromCenterAndRadius (new Position (37, -122), Distance.FromMiles (10)));
  110. var pin = new Pin () {
  111. Position = new Position (37, -122),
  112. Label = "Some Pin!"
  113. };
  114. map.Pins.Add (pin);
  115. var cp = new ContentPage {
  116. Content = map,
  117. };
  118. ]]></code>
  119. </example>
  120. <para>
  121. <img href="Pin.Label.png" />
  122. </para>
  123. </remarks>
  124. </member>
  125. <member name="C:Xamarin.Forms.Maps.Map">
  126. <summary>Creates a new <see cref="T:Xamarin.Forms.Maps.Map" /> object with default values.</summary>
  127. <remarks>To be added.</remarks>
  128. </member>
  129. <member name="C:Xamarin.Forms.Maps.Map(Xamarin.Forms.Maps.MapSpan)">
  130. <param name="region">To be added.</param>
  131. <summary>Creates a new <see cref="T:Xamarin.Forms.Maps.Map" /> object with that shows the region that is specified by <paramref name="region" />.</summary>
  132. <remarks>To be added.</remarks>
  133. </member>
  134. <member name="M:Xamarin.Forms.Maps.Map.GetEnumerator">
  135. <summary>An <see cref="T:System.Collections.Generic.IEnumerator`1" /> of the <see cref="T:Xamarin.Forms.Maps.Pin" />s on this <see cref="T:Xamarin.Forms.Maps.Map" />.</summary>
  136. <returns>To be added.</returns>
  137. <remarks>To be added.</remarks>
  138. </member>
  139. <member name="P:Xamarin.Forms.Maps.Map.HasScrollEnabled">
  140. <summary>Whether this <see cref="T:Xamarin.Forms.Maps.Map" /> is allowed to scroll.</summary>
  141. <value>
  142. <see langword="true" /> if scrolling is enabled.</value>
  143. <remarks>To be added.</remarks>
  144. </member>
  145. <member name="F:Xamarin.Forms.Maps.Map.HasScrollEnabledProperty">
  146. <summary>Identifies the <see cref="P:Xamarin.Forms.Maps.Map.HasScrollEnabled" /> bindable property.</summary>
  147. <remarks>To be added.</remarks>
  148. </member>
  149. <member name="P:Xamarin.Forms.Maps.Map.HasZoomEnabled">
  150. <summary>Whether this <see cref="T:Xamarin.Forms.Maps.Map" /> is allowed to zoom.</summary>
  151. <value>
  152. <see langword="true" /> if zooming is enabled.</value>
  153. <remarks>To be added.</remarks>
  154. </member>
  155. <member name="F:Xamarin.Forms.Maps.Map.HasZoomEnabledProperty">
  156. <summary>Identifies the <see cref="P:Xamarin.Forms.Maps.Map.HasZoomEnabled" /> bindable property.</summary>
  157. <remarks>To be added.</remarks>
  158. </member>
  159. <member name="P:Xamarin.Forms.Maps.Map.IsShowingUser">
  160. <summary>Whether this <see cref="T:Xamarin.Forms.Maps.Map" /> is showing the user's current location.</summary>
  161. <value>
  162. <see langword="true" /> if the user's current location is being displayed.</value>
  163. <remarks>To be added.</remarks>
  164. </member>
  165. <member name="F:Xamarin.Forms.Maps.Map.IsShowingUserProperty">
  166. <summary>Identifies the <see cref="P:Xamarin.Forms.Maps.Map.IsShowingUser" /> bindable property.</summary>
  167. <remarks>To be added.</remarks>
  168. </member>
  169. <member name="P:Xamarin.Forms.Maps.Map.MapType">
  170. <summary>The <see cref="T:Xamarin.Forms.Maps.MapType" /> display style of this <see cref="T:Xamarin.Forms.Maps.Map" />.</summary>
  171. <value>To be added.</value>
  172. <remarks>To be added.</remarks>
  173. </member>
  174. <member name="F:Xamarin.Forms.Maps.Map.MapTypeProperty">
  175. <summary>Identifies the <see cref="P:Xamarin.Forms.Maps.Map.MapType" /> bindable property.</summary>
  176. <remarks>To be added.</remarks>
  177. </member>
  178. <member name="M:Xamarin.Forms.Maps.Map.MoveToRegion(Xamarin.Forms.Maps.MapSpan)">
  179. <param name="mapSpan">The <see cref="T:Xamarin.Forms.Maps.MapSpan" /> to make visible.</param>
  180. <summary>Moves the map so that it displays the specified <paramref name="mapSpan" />.</summary>
  181. <remarks>To be added.</remarks>
  182. </member>
  183. <member name="P:Xamarin.Forms.Maps.Map.Pins">
  184. <summary>An <see cref="T:System.Collections.IList`1" /> of the <see cref="T:Xamarin.Forms.Maps.Pin" />s on this <see cref="T:Xamarin.Forms.Maps.Map" />.</summary>
  185. <value>To be added.</value>
  186. <remarks>To be added.</remarks>
  187. </member>
  188. <member name="M:Xamarin.Forms.Maps.Map.System#Collections#IEnumerable#GetEnumerator">
  189. <summary>An <see cref="T:System.Collections.IEnumerator" /> of the <see cref="T:Xamarin.Forms.Maps.Pin" />s on this <see cref="T:Xamarin.Forms.Maps.Map" />.</summary>
  190. <returns>To be added.</returns>
  191. <remarks>To be added.</remarks>
  192. </member>
  193. <member name="P:Xamarin.Forms.Maps.Map.VisibleRegion">
  194. <summary>The currently visible <see cref="T:Xamarin.Forms.Maps.MapSpan" /> of this <see cref="T:Xamarin.Forms.Maps.Map" />.</summary>
  195. <value>To be added.</value>
  196. <remarks>To be added.</remarks>
  197. </member>
  198. <member name="T:Xamarin.Forms.Maps.MapSpan">
  199. <summary>A circular region on a <see cref="T:Xamarin.Forms.Maps.Map" />.</summary>
  200. <remarks>To be added.</remarks>
  201. </member>
  202. <member name="C:Xamarin.Forms.Maps.MapSpan(Xamarin.Forms.Maps.Position,System.Double,System.Double)">
  203. <param name="center">To be added.</param>
  204. <param name="latitudeDegrees">To be added.</param>
  205. <param name="longitudeDegrees">To be added.</param>
  206. <summary>Returns a <see cref="T:Xamarin.Forms.Maps.MapSpan" /> that is centered on <paramref name="center" /> and extends to <paramref name="latitudeDegress" /> and <paramref name="longitudeDegress" />.</summary>
  207. <remarks>To be added.</remarks>
  208. </member>
  209. <member name="P:Xamarin.Forms.Maps.MapSpan.Center">
  210. <summary>The <see cref="T:Xamarin.Forms.Maps.Position" /> in the geographical center of the <see cref="T:Xamarin.Forms.Maps.MapSpan" />.</summary>
  211. <value>To be added.</value>
  212. <remarks>To be added.</remarks>
  213. </member>
  214. <member name="M:Xamarin.Forms.Maps.MapSpan.ClampLatitude(System.Double,System.Double)">
  215. <param name="north">The northern limit of the new <see cref="T:Xamarin.Forms.Maps.MapSpan" />.</param>
  216. <param name="south">The southern limit of the new <see cref="T:Xamarin.Forms.Maps.MapSpan" />.</param>
  217. <summary>Creates a new <see cref="T:Xamarin.Forms.Maps.MapSpan" /> with the same <see cref="P:Xamarin.Forms.Maps.MapSpan.LongitudeDegrees" /> as <c>this</c> and a radius defined by <paramref name="north" /> and <paramref name="south" />.</summary>
  218. <returns>A new <see cref="T:Xamarin.Forms.Maps.MapSpan" />.</returns>
  219. <remarks>To be added.</remarks>
  220. </member>
  221. <member name="M:Xamarin.Forms.Maps.MapSpan.Equals(System.Object)">
  222. <param name="obj">To be added.</param>
  223. <summary>Whether <paramref name="obj" /> is a <see cref="T:Xamarin.Forms.MapsSpan" /> with identical position and radius values as this <see cref="T:Xamarin.Forms.Maps.MapSpan" />.</summary>
  224. <returns>
  225. <see langword="true" /> if <paramref name="obj" /> is a <see cref="T:Xamarin.Forms.MapsSpan" /> with identical position and radius values as this <see cref="T:Xamarin.Forms.Maps.MapSpan" />.</returns>
  226. <remarks>To be added.</remarks>
  227. </member>
  228. <member name="M:Xamarin.Forms.Maps.MapSpan.FromCenterAndRadius(Xamarin.Forms.Maps.Position,Xamarin.Forms.Maps.Distance)">
  229. <param name="center">To be added.</param>
  230. <param name="radius">To be added.</param>
  231. <summary>Returns a <see cref="Xamarin.Forms.Maps.MapSpan" /> that displays the area that is defined by <paramref name="center" /> and <paramref name="radius" />.</summary>
  232. <returns>To be added.</returns>
  233. <remarks>To be added.</remarks>
  234. </member>
  235. <member name="M:Xamarin.Forms.Maps.MapSpan.GetHashCode">
  236. <summary>The hash value for this <see cref="T:Xamarin.Forms.Maps.MapSpan" />, based on the position and radius.</summary>
  237. <returns>A value optimized for insertion and retrieval in hash-based data structures.</returns>
  238. <remarks>To be added.</remarks>
  239. </member>
  240. <member name="P:Xamarin.Forms.Maps.MapSpan.LatitudeDegrees">
  241. <summary>The degrees of latitude that are spanned by the <see cref="T:Xamarin.Forms.Maps.MapSpan" />.</summary>
  242. <value>The number of degrees of latitude that are spanned by the <see cref="T:Xamarin.Forms.Maps.MapSpan" />.</value>
  243. <remarks>To be added.</remarks>
  244. </member>
  245. <member name="P:Xamarin.Forms.Maps.MapSpan.LongitudeDegrees">
  246. <summary>The degrees of longitude that are spanned by the <see cref="T:Xamarin.Forms.Maps.MapSpan" />.</summary>
  247. <value>The number of degrees of longitude that are spanned by the <see cref="T:Xamarin.Forms.Maps.MapSpan" />.</value>
  248. <remarks>To be added.</remarks>
  249. </member>
  250. <member name="M:Xamarin.Forms.Maps.MapSpan.op_Equality(Xamarin.Forms.Maps.MapSpan,Xamarin.Forms.Maps.MapSpan)">
  251. <param name="left">A <see cref="T:Xamarin.Forms.Maps.MapSpan" /> to be compared.</param>
  252. <param name="right">A <see cref="T:Xamarin.Forms.Maps.MapSpan" /> to be compared.</param>
  253. <summary>Whether two <see cref="T:Xamarin.Forms.Maps.MapSpan" /> have equivalent values.</summary>
  254. <returns>
  255. <see langword="true" /> if the two <see cref="T:Xamarin.Forms.Maps.MapSpan" />s have equivalent <see cref="P:Xamarin.Forms.Maps.MapSpan.Center" /> and <see cref="P:Xamarin.Forms.Maps.MapSpan.Radius" /> values.</returns>
  256. <remarks>To be added.</remarks>
  257. </member>
  258. <member name="M:Xamarin.Forms.Maps.MapSpan.op_Inequality(Xamarin.Forms.Maps.MapSpan,Xamarin.Forms.Maps.MapSpan)">
  259. <param name="left">A <see cref="T:Xamarin.Forms.Maps.MapSpan" /> to be compared.</param>
  260. <param name="right">A <see cref="T:Xamarin.Forms.Maps.MapSpan" /> to be compared.</param>
  261. <summary>Whether two <see cref="T:Xamarin.Forms.Maps.MapSpan" /> have different values.</summary>
  262. <returns>
  263. <see langword="true" /> if the two <see cref="T:Xamarin.Forms.Maps.MapSpan" />s have different values for either <see cref="P:Xamarin.Forms.Maps.MapSpan.Center" /> or <see cref="P:Xamarin.Forms.Maps.MapSpan.Radius" />.</returns>
  264. <remarks>To be added.</remarks>
  265. </member>
  266. <member name="P:Xamarin.Forms.Maps.MapSpan.Radius">
  267. <summary>Gets the smallest distance across the <see cref="T:Xamarin.Forms.Maps.MapSpan" />.</summary>
  268. <value>The smallest distance across the <see cref="T:Xamarin.Forms.Maps.MapSpan" />.</value>
  269. <remarks>Application developers can get the distance in their desired units from the returned <see cref="T:Xamarin.Forms.Distance" /> struct.</remarks>
  270. </member>
  271. <member name="M:Xamarin.Forms.Maps.MapSpan.WithZoom(System.Double)">
  272. <param name="zoomFactor">The factor by which to enlarge or decrease <c>this</c>.</param>
  273. <summary>Creates a new <see cref="T:Xamarin.Forms.Maps.MapSpan" /> with the same <see cref="P:Xamarin.Forms.Maps.MapSpan.Center" /> as <c>this</c> but with a <see cref="P:Xamarin.Forms.Maps.MapSpan.Radius" /> multiplied by <paramref name="zoomFactor" />.</summary>
  274. <returns>To be added.</returns>
  275. <remarks>To be added.</remarks>
  276. </member>
  277. <member name="T:Xamarin.Forms.Maps.MapType">
  278. <summary>Enumeration that specifies the display style of the map.</summary>
  279. <remarks>To be added.</remarks>
  280. </member>
  281. <member name="F:Xamarin.Forms.Maps.MapType.Hybrid">
  282. <summary>A map that combinse satellite imagery and street data.</summary>
  283. </member>
  284. <member name="F:Xamarin.Forms.Maps.MapType.Satellite">
  285. <summary>A map that contains satellite imagery.</summary>
  286. </member>
  287. <member name="F:Xamarin.Forms.Maps.MapType.Street">
  288. <summary>A street map.</summary>
  289. </member>
  290. <member name="T:Xamarin.Forms.Maps.Pin">
  291. <summary>A marker on a <see cref="T:Xamarin.Forms.Maps.Map" />.</summary>
  292. <remarks>
  293. <para> A <see cref="T:Xamarin.Forms.Maps.Pin" /> must have its <see cref="P:Xamarin.Forms.Maps.Pin.Label" /> property assigned before it is added to a map. If not, a <see cref="T:System.ArgumentException" /> is thrown.</para>
  294. <example>
  295. <code lang="C#"><![CDATA[
  296. public static Page GetMapPage ()
  297. {
  298. var map = new Map (MapSpan.FromCenterAndRadius (new Position (37, -122), Distance.FromMiles (10)));
  299. //If Label is not set, runtime exception
  300. var pin = new Pin () {
  301. Position = new Position (37, -122),
  302. Label = "Some Pin!"
  303. };
  304. map.Pins.Add (pin);
  305. var cp = new ContentPage {
  306. Content = map,
  307. };
  308. return cp;
  309. }
  310. ]]></code>
  311. </example>
  312. </remarks>
  313. </member>
  314. <member name="C:Xamarin.Forms.Maps.Pin">
  315. <summary>Creates a new <see cref="T:Xamarin.Forms.Maps.Pin" /> object with default values.</summary>
  316. <remarks>To be added.</remarks>
  317. </member>
  318. <member name="P:Xamarin.Forms.Maps.Pin.Address">
  319. <summary>A <langword see="string" /> describing the street address.</summary>
  320. <value>To be added.</value>
  321. <remarks>To be added.</remarks>
  322. </member>
  323. <member name="F:Xamarin.Forms.Maps.Pin.AddressProperty">
  324. <summary>Identifies the <see cref="P:Xamarin.Forms.Maps.Pin.Address" /> bindable property.</summary>
  325. <remarks>To be added.</remarks>
  326. </member>
  327. <member name="E:Xamarin.Forms.Maps.Pin.Clicked">
  328. <summary>Event that is raised when the pin is clicked.</summary>
  329. <remarks>To be added.</remarks>
  330. </member>
  331. <member name="M:Xamarin.Forms.Maps.Pin.Equals(System.Object)">
  332. <param name="obj">To be added.</param>
  333. <summary>Whether <paramref name="obj" /> with equivalent <see cref="P:Xamarin.Forms.Maps.Pin.Type" />, <see cref="P:Xamarin.Forms.Maps.Pin.Position" />, <see cref="P:Xamarin.Forms.Maps.Pin.Label" /> and <see cref="P:Xamarin.Forms.Maps.Pin.Address" />.</summary>
  334. <returns>
  335. <see langword="true" /> if <paramref name="obj" /> is a <see cref="T:Xamarin.Forms.Maps.Pin" /> with equivalent <see cref="P:Xamarin.Forms.Maps.Pin.Type" />, <see cref="P:Xamarin.Forms.Maps.Pin.Position" />, <see cref="P:Xamarin.Forms.Maps.Pin.Label" /> and <see cref="P:Xamarin.Forms.Maps.Pin.Address" /> values.</returns>
  336. <remarks>To be added.</remarks>
  337. </member>
  338. <member name="M:Xamarin.Forms.Maps.Pin.GetHashCode">
  339. <summary>The hash value for the <see cref="T:Xamarin.Forms.Maps.Pin" /></summary>
  340. <returns>A value optimized for fast insertion and retrieval in a hash-based data structure.</returns>
  341. <remarks>
  342. <para>A <see cref="T:Xamarin.Forms.Maps.Pin" /> hash-value is based on its <see cref="P:Xamarin.Forms.Maps.Pin.Type" />, <see cref="P:Xamarin.Forms.Maps.Pin.Position" />, <see cref="P:Xamarin.Forms.Maps.Pin.Label" /> and <see cref="P:Xamarin.Forms.Maps.Pin.Address" /> properties.</para>
  343. </remarks>
  344. </member>
  345. <member name="P:Xamarin.Forms.Maps.Pin.Label">
  346. <summary>A user-readable <langword see="string" /> associated with the <see cref="T:Xamarin.Forms.Maps.Pin" />.</summary>
  347. <value>To be added.</value>
  348. <remarks>To be added.</remarks>
  349. </member>
  350. <member name="M:Xamarin.Forms.Maps.Pin.op_Equality(Xamarin.Forms.Maps.Pin,Xamarin.Forms.Maps.Pin)">
  351. <param name="left">A <see cref="T:Xamarin.Forms.Maps.Pin" /> to be compared.</param>
  352. <param name="right">A <see cref="T:Xamarin.Forms.Maps.Pin" /> to be compared.</param>
  353. <summary>Whether <paramref name="left" /> and <paramref name="right" /> have equivalent <see cref="P:Xamarin.Forms.Maps.Pin.Type" />, <see cref="P:Xamarin.Forms.Maps.Pin.Position" />, <see cref="P:Xamarin.Forms.Maps.Pin.Label" /> and <see cref="P:Xamarin.Forms.Maps.Pin.Address" /> values.</summary>
  354. <returns>
  355. <see langword="true" /> if <paramref name="left" /> and <paramref name="right" /> have equivalent <see cref="P:Xamarin.Forms.Maps.Pin.Type" />, <see cref="P:Xamarin.Forms.Maps.Pin.Position" />, <see cref="P:Xamarin.Forms.Maps.Pin.Label" /> and <see cref="P:Xamarin.Forms.Maps.Pin.Address" /> values.</returns>
  356. <remarks>To be added.</remarks>
  357. </member>
  358. <member name="M:Xamarin.Forms.Maps.Pin.op_Inequality(Xamarin.Forms.Maps.Pin,Xamarin.Forms.Maps.Pin)">
  359. <param name="left">A <see cref="T:Xamarin.Forms.Maps.Pin" /> to be compared.</param>
  360. <param name="right">A <see cref="T:Xamarin.Forms.Maps.Pin" /> to be compared.</param>
  361. <summary>Whether <paramref name="left" /> and <paramref name="right" /> differ in any of their <see cref="P:Xamarin.Forms.Maps.Pin.Type" />, <see cref="P:Xamarin.Forms.Maps.Pin.Position" />, <see cref="P:Xamarin.Forms.Maps.Pin.Label" /> and <see cref="P:Xamarin.Forms.Maps.Pin.Address" /> values.</summary>
  362. <returns>
  363. <see langword="true" /> if <paramref name="left" /> and <paramref name="right" /> have any differences between their <see cref="P:Xamarin.Forms.Maps.Pin.Type" />, <see cref="P:Xamarin.Forms.Maps.Pin.Position" />, <see cref="P:Xamarin.Forms.Maps.Pin.Label" /> and <see cref="P:Xamarin.Forms.Maps.Pin.Address" /> values.</returns>
  364. <remarks>To be added.</remarks>
  365. </member>
  366. <member name="P:Xamarin.Forms.Maps.Pin.Position">
  367. <summary>The latitude and longitude of the <see cref="T:Xamarin.Forms.Maps.Pin" />.</summary>
  368. <value>The <see cref="T:Xamarin.Forms.Maps.Position" /> of the <see cref="T:Xamarin.Forms.Maps.Pin" />.</value>
  369. <remarks>To be added.</remarks>
  370. </member>
  371. <member name="F:Xamarin.Forms.Maps.Pin.PositionProperty">
  372. <summary>Identifies the <see cref="P:Xamarin.Forms.Maps.Pin.Position" /> bindable property.</summary>
  373. <remarks>To be added.</remarks>
  374. </member>
  375. <member name="P:Xamarin.Forms.Maps.Pin.Type">
  376. <summary>The kind of pin.</summary>
  377. <value>To be added.</value>
  378. <remarks>To be added.</remarks>
  379. </member>
  380. <member name="F:Xamarin.Forms.Maps.Pin.TypeProperty">
  381. <summary>Identifies the <see cref="T:Xamarin.Forms.Maps.Pin.Type" /> bindable property.</summary>
  382. <remarks>To be added.</remarks>
  383. </member>
  384. <member name="T:Xamarin.Forms.Maps.PinType">
  385. <summary>Enumeration specifying the various kinds of <see cref="T:Xamarin.Forms.Map.Pin" />.</summary>
  386. <remarks>To be added.</remarks>
  387. </member>
  388. <member name="F:Xamarin.Forms.Maps.PinType.Generic">
  389. <summary>A generic pin.</summary>
  390. </member>
  391. <member name="F:Xamarin.Forms.Maps.PinType.Place">
  392. <summary>Pin for a place.</summary>
  393. </member>
  394. <member name="F:Xamarin.Forms.Maps.PinType.SavedPin">
  395. <summary>Pin for a saved location.</summary>
  396. </member>
  397. <member name="F:Xamarin.Forms.Maps.PinType.SearchResult">
  398. <summary>Pin for a search result.</summary>
  399. </member>
  400. <member name="T:Xamarin.Forms.Maps.Position">
  401. <summary>A struct that has a latitude and longitude, stored as doubles.</summary>
  402. <remarks>To be added.</remarks>
  403. </member>
  404. <member name="C:Xamarin.Forms.Maps.Position(System.Double,System.Double)">
  405. <param name="latitude">The latitude of the new position in degrees, as a double. This value will be clamped between -90.0 and 90.0, inclusive.</param>
  406. <param name="longitude">The longitude of the new position, as a double. This value will be clamped between -180.0 and 180.0, inclusive.</param>
  407. <summary>Constructs a new <see cref="T:Xamarin.Forms.Maps.Position" /> structure with a given latitude and longitude.</summary>
  408. <remarks>To be added.</remarks>
  409. </member>
  410. <member name="M:Xamarin.Forms.Maps.Position.Equals(System.Object)">
  411. <param name="obj">To be added.</param>
  412. <summary>Returns a Boolean value that indicates whether or not <paramref name="obj" /> is another <see cref="T:Xamarin.Forms.Position" /> structure and represents exactly the same latitude and longitude as <see langword="this" /> one.</summary>
  413. <returns>
  414. <see langword="true" /> if <paramref name="obj" /> is another <see cref="T:Xamarin.Forms.Position" /> structure and represents exactly the same latitude and longitude as <see langword="this" /> one. Otherwise, <see langword="false" />.</returns>
  415. <remarks>To be added.</remarks>
  416. </member>
  417. <member name="M:Xamarin.Forms.Maps.Position.GetHashCode">
  418. <summary>Returns the hash code for this instance.</summary>
  419. <returns>The hash code for this instance.</returns>
  420. <remarks>To be added.</remarks>
  421. </member>
  422. <member name="P:Xamarin.Forms.Maps.Position.Latitude">
  423. <summary>Gets the latitude of this position in decimal degrees.</summary>
  424. <value>The latitude of this position in degrees, as a double. The returned value will be between -90.0 and 90.0 degrees, inclusive.</value>
  425. <remarks>To be added.</remarks>
  426. </member>
  427. <member name="P:Xamarin.Forms.Maps.Position.Longitude">
  428. <summary>Gets the longitude of this position in decimal degrees.</summary>
  429. <value>The longitude of this position in degrees, as a double. The returned value will be between -180.0 and 180.0 degrees, inclusive.</value>
  430. <remarks>To be added.</remarks>
  431. </member>
  432. <member name="M:Xamarin.Forms.Maps.Position.op_Equality(Xamarin.Forms.Maps.Position,Xamarin.Forms.Maps.Position)">
  433. <param name="left">A <see cref="T:Xamarin.Forms.Maps.Position" /> to compare.</param>
  434. <param name="right">A <see cref="T:Xamarin.Forms.Maps.Position" /> to compare.</param>
  435. <summary>Returns a Boolean value that indicates whether or not <paramref name="left" /> represents exactly the same latitude and longitude as <paramref name="right" />.</summary>
  436. <returns>
  437. <see langword="true" /> if <paramref name="left" /> represents exactly the same latitude and longitude as <paramref name="right" />. Otherwise, <see langword="false" />.</returns>
  438. <remarks>To be added.</remarks>
  439. </member>
  440. <member name="M:Xamarin.Forms.Maps.Position.op_Inequality(Xamarin.Forms.Maps.Position,Xamarin.Forms.Maps.Position)">
  441. <param name="left">A <see cref="T:Xamarin.Forms.Maps.Position" /> to compare.</param>
  442. <param name="right">A <see cref="T:Xamarin.Forms.Maps.Position" /> to compare.</param>
  443. <summary>Returns a Boolean value that indicates whether or not <paramref name="left" /> and <paramref name="right" /> represent different latitudes or longitudes.</summary>
  444. <returns>
  445. <see langword="true" /> if <paramref name="left" /> and <paramref name="right" /> represent different latitudes or longitudes. Otherwise, <see langword="false" />.</returns>
  446. <remarks>To be added.</remarks>
  447. </member>
  448. </members>
  449. </doc>