summaryrefslogtreecommitdiff
path: root/docs/Xamarin.Forms.Maps/Xamarin.Forms.Maps/Distance.xml
blob: a04a471b04850da4c6f2e41cccab6a38843ca491 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
<Type Name="Distance" FullName="Xamarin.Forms.Maps.Distance">
  <TypeSignature Language="C#" Value="public struct Distance" />
  <TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit Distance extends System.ValueType" />
  <AssemblyInfo>
    <AssemblyName>Xamarin.Forms.Maps</AssemblyName>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
    <AssemblyVersion>1.1.0.0</AssemblyVersion>
    <AssemblyVersion>1.3.0.0</AssemblyVersion>
    <AssemblyVersion>1.4.0.0</AssemblyVersion>
    <AssemblyVersion>1.5.0.0</AssemblyVersion>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.ValueType</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>Struct that encapsulates a distance (natively stored as a double of meters).</summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public Distance (double meters);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(float64 meters) cil managed" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
        <AssemblyVersion>1.3.0.0</AssemblyVersion>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
        <AssemblyVersion>1.5.0.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="meters" Type="System.Double" />
      </Parameters>
      <Docs>
        <param name="meters">The distance value, in meters, with which to initialize a new <see cref="T:Xamarin.Forms.Maps.Distance" /> structure.</param>
        <summary>Creates a new <see cref="T:Xamarin.Forms.Maps.Distance" /> that represents the distance described by <paramref name="meters" />.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Equals">
      <MemberSignature Language="C#" Value="public override bool Equals (object obj);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object obj) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
        <AssemblyVersion>1.3.0.0</AssemblyVersion>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
        <AssemblyVersion>1.5.0.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="obj" Type="System.Object" />
      </Parameters>
      <Docs>
        <param name="obj">An Object to compare to <c>this</c>.</param>
        <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>
        <returns>
          <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>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Equals">
      <MemberSignature Language="C#" Value="public bool Equals (Xamarin.Forms.Maps.Distance other);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Equals(valuetype Xamarin.Forms.Maps.Distance other) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
        <AssemblyVersion>1.3.0.0</AssemblyVersion>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
        <AssemblyVersion>1.5.0.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="other" Type="Xamarin.Forms.Maps.Distance" />
      </Parameters>
      <Docs>
        <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>
        <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>
        <returns>
          <see langword="true" /> if <paramref name="other" /> has exactly the same value as <c>this</c><see cref="T:Xamaring.Forms.Maps.Distance" />.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="FromKilometers">
      <MemberSignature Language="C#" Value="public static Xamarin.Forms.Maps.Distance FromKilometers (double kilometers);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype Xamarin.Forms.Maps.Distance FromKilometers(float64 kilometers) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
        <AssemblyVersion>1.3.0.0</AssemblyVersion>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
        <AssemblyVersion>1.5.0.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Xamarin.Forms.Maps.Distance</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="kilometers" Type="System.Double" />
      </Parameters>
      <Docs>
        <param name="kilometers">A double value representing the distance, in kilometers, for the <see cref="T:Xamarin.Forms.Maps.Distance" /> to create.</param>
        <summary>Factory method to create a <see cref="T:Xamarin.Forms.Maps.Distance" /> from a value provided in kilometers.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="FromMeters">
      <MemberSignature Language="C#" Value="public static Xamarin.Forms.Maps.Distance FromMeters (double meters);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype Xamarin.Forms.Maps.Distance FromMeters(float64 meters) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
        <AssemblyVersion>1.3.0.0</AssemblyVersion>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
        <AssemblyVersion>1.5.0.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Xamarin.Forms.Maps.Distance</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="meters" Type="System.Double" />
      </Parameters>
      <Docs>
        <param name="meters">A double value representing the distance, in meters, for the <see cref="T:Xamarin.Forms.Maps.Distance" /> to create.</param>
        <summary>Factory method to create a <see cref="T:Xamarin.Forms.Maps.Distance" /> from a value provided in meters.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="FromMiles">
      <MemberSignature Language="C#" Value="public static Xamarin.Forms.Maps.Distance FromMiles (double miles);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype Xamarin.Forms.Maps.Distance FromMiles(float64 miles) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
        <AssemblyVersion>1.3.0.0</AssemblyVersion>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
        <AssemblyVersion>1.5.0.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Xamarin.Forms.Maps.Distance</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="miles" Type="System.Double" />
      </Parameters>
      <Docs>
        <param name="miles">A double value representing the distance, in miles, for the <see cref="T:Xamarin.Forms.Maps.Distance" /> to create.</param>
        <summary>Factory method to create a <see cref="T:Xamarin.Forms.Maps.Distance" /> from a value provided in miles.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetHashCode">
      <MemberSignature Language="C#" Value="public override int GetHashCode ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
        <AssemblyVersion>1.3.0.0</AssemblyVersion>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
        <AssemblyVersion>1.5.0.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>The hashcode for the <see cref="T:Xamarin.Forms.Maps.Distance" />.</summary>
        <returns>A value optimized for fast insertion and retrieval in a hash-based data structure.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Kilometers">
      <MemberSignature Language="C#" Value="public double Kilometers { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance float64 Kilometers" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
        <AssemblyVersion>1.3.0.0</AssemblyVersion>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
        <AssemblyVersion>1.5.0.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Double</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the distance in kilometers that is spanned by <c>this</c><see cref="T:Xamarin.Forms.Maps.Distance" />.</summary>
        <value>The distance in kilometers that is spanned by <c>this</c><see cref="T:Xamarin.Forms.Maps.Distance" /></value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Meters">
      <MemberSignature Language="C#" Value="public double Meters { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance float64 Meters" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
        <AssemblyVersion>1.3.0.0</AssemblyVersion>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
        <AssemblyVersion>1.5.0.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Double</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the distance in meters that is spanned by <c>this</c><see cref="T:Xamarin.Forms.Maps.Distance" />.</summary>
        <value>Toe distance in meters that is spanned by <c>this</c><see cref="T:Xamarin.Forms.Maps.Distance" />.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Miles">
      <MemberSignature Language="C#" Value="public double Miles { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance float64 Miles" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
        <AssemblyVersion>1.3.0.0</AssemblyVersion>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
        <AssemblyVersion>1.5.0.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Double</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the distance in miles that is spanned by <c>this</c><see cref="T:Xamarin.Forms.Maps.Distance" />.</summary>
        <value>The distance in miles that is spanned by <c>this</c><see cref="T:Xamarin.Forms.Maps.Distance" />.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="op_Equality">
      <MemberSignature Language="C#" Value="public static bool op_Equality (Xamarin.Forms.Maps.Distance left, Xamarin.Forms.Maps.Distance right);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Equality(valuetype Xamarin.Forms.Maps.Distance left, valuetype Xamarin.Forms.Maps.Distance right) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
        <AssemblyVersion>1.3.0.0</AssemblyVersion>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
        <AssemblyVersion>1.5.0.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="left" Type="Xamarin.Forms.Maps.Distance" />
        <Parameter Name="right" Type="Xamarin.Forms.Maps.Distance" />
      </Parameters>
      <Docs>
        <param name="left">A <see cref="T:Xamarin.Forms.Maps.Distance" /> to compare to another <see cref="T:Xamarin.Forms.Maps.Distance" />.</param>
        <param name="right">A <see cref="T:Xamarin.Forms.Maps.Distance" /> to compare to <paramref name="left" />.</param>
        <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>
        <returns>
          <see langword="true" /> if <paramref name="left" /> and <paramref name="right" /> have identical <see cref="P:Xamarin.Forms.Maps.Distance.Meters" /> properties.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="op_Inequality">
      <MemberSignature Language="C#" Value="public static bool op_Inequality (Xamarin.Forms.Maps.Distance left, Xamarin.Forms.Maps.Distance right);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Inequality(valuetype Xamarin.Forms.Maps.Distance left, valuetype Xamarin.Forms.Maps.Distance right) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
        <AssemblyVersion>1.3.0.0</AssemblyVersion>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
        <AssemblyVersion>1.5.0.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="left" Type="Xamarin.Forms.Maps.Distance" />
        <Parameter Name="right" Type="Xamarin.Forms.Maps.Distance" />
      </Parameters>
      <Docs>
        <param name="left">A <see cref="T:Xamarin.Forms.Maps.Distance" /> to compare to another <see cref="T:Xamarin.Forms.Maps.Distance" />.</param>
        <param name="right">A <see cref="T:Xamarin.Forms.Maps.Distance" /> to compare to <paramref name="left" />.</param>
        <summary>Whether two <see cref="T:Xamarin.Forms.Maps.Distance" />s have differing <see cref="P:Xamarin.Forms.Maps.Distance.Meters" /> properties.</summary>
        <returns>
          <see langword="true" /> if <paramref name="left" /> and <paramref name="right" /> have different <see cref="P:Xamarin.Forms.Maps.Distance.Meters" /> properties.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>