-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
CivicAddressResolver.xml
201 lines (175 loc) · 13.8 KB
/
CivicAddressResolver.xml
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
<Type Name="CivicAddressResolver" FullName="System.Device.Location.CivicAddressResolver">
<TypeSignature Language="C#" Value="public sealed class CivicAddressResolver : System.Device.Location.ICivicAddressResolver" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit CivicAddressResolver extends System.Object implements class System.Device.Location.ICivicAddressResolver" />
<TypeSignature Language="DocId" Value="T:System.Device.Location.CivicAddressResolver" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class CivicAddressResolver
Implements ICivicAddressResolver" />
<TypeSignature Language="F#" Value="type CivicAddressResolver = class
 interface ICivicAddressResolver" />
<TypeSignature Language="C++ CLI" Value="public ref class CivicAddressResolver sealed : System::Device::Location::ICivicAddressResolver" />
<AssemblyInfo>
<AssemblyName>System.Device</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.Device.Location.ICivicAddressResolver</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>Provides functionality for resolving a coordinate-based location to a civic address.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Device.Location.CivicAddressResolver> class provides an implementation of <xref:System.Device.Location.ICivicAddressResolver> that resolves a coordinate-based location to a civic address if the location provider provides both coordinates and civic address data.
## Examples
The following program shows how to call <xref:System.Device.Location.CivicAddressResolver.ResolveAddress%2A> to resolve a civic address synchronously.
:::code language="csharp" source="~/snippets/csharp/System.Device.Location/CivicAddress/Overview/resolvecivicaddresssync.cs" id="Snippet1":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Misc/system.device.location.resolvecivicaddresssync/vb/resolvecivicaddresssync.vb" id="Snippet1":::
The following program shows how to call <xref:System.Device.Location.CivicAddressResolver.ResolveAddressAsync%2A> to resolve a civic address asynchronously.
:::code language="csharp" source="~/snippets/csharp/System.Device.Location/CivicAddress/Overview/resolvecivicaddresssync.cs" id="Snippet1":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Misc/system.device.location.resolvecivicaddresssync/vb/resolvecivicaddresssync.vb" id="Snippet1":::
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CivicAddressResolver ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Device.Location.CivicAddressResolver.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 CivicAddressResolver();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Device</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Device.Location.CivicAddressResolver" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following example shows how to initialize a new instance of the <xref:System.Device.Location.CivicAddressResolver> class.
```csharp
CivicAddressResolver resolver = new CivicAddressResolver();
```
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ResolveAddress">
<MemberSignature Language="C#" Value="public System.Device.Location.CivicAddress ResolveAddress (System.Device.Location.GeoCoordinate coordinate);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Device.Location.CivicAddress ResolveAddress(class System.Device.Location.GeoCoordinate coordinate) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Device.Location.CivicAddressResolver.ResolveAddress(System.Device.Location.GeoCoordinate)" />
<MemberSignature Language="VB.NET" Value="Public Function ResolveAddress (coordinate As GeoCoordinate) As CivicAddress" />
<MemberSignature Language="F#" Value="abstract member ResolveAddress : System.Device.Location.GeoCoordinate -> System.Device.Location.CivicAddress
override this.ResolveAddress : System.Device.Location.GeoCoordinate -> System.Device.Location.CivicAddress" Usage="civicAddressResolver.ResolveAddress coordinate" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual System::Device::Location::CivicAddress ^ ResolveAddress(System::Device::Location::GeoCoordinate ^ coordinate);" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.Device.Location.ICivicAddressResolver.ResolveAddress(System.Device.Location.GeoCoordinate)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>System.Device</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Device.Location.CivicAddress</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="coordinate" Type="System.Device.Location.GeoCoordinate" />
</Parameters>
<Docs>
<param name="coordinate">The <see cref="T:System.Device.Location.GeoCoordinate" /> containing the location to resolve to a civic address.</param>
<summary>Synchronously resolves a civic address from a location based on latitude and longitude. This call will block execution of the calling thread while the address is being resolved.</summary>
<returns>The civic address that is resolved from the <paramref name="coordinate" /> parameter. <see cref="F:System.Device.Location.CivicAddress.Unknown" /> is returned if the address cannot be resolved.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Device.Location.ICivicAddressResolver.ResolveAddressCompleted> event is raised when the address resolve operation completes. The civic address that is resolved from the `coordinate` parameter is returned by the <xref:System.Device.Location.ResolveAddressCompletedEventArgs.Address%2A> member of the <xref:System.Device.Location.ResolveAddressCompletedEventArgs> object that is passed to the event handler.
## Examples
The following program demonstrates how to call <xref:System.Device.Location.CivicAddressResolver.ResolveAddress%2A> to resolve a civic address synchronously.
:::code language="csharp" source="~/snippets/csharp/System.Device.Location/CivicAddress/Overview/resolvecivicaddresssync.cs" id="Snippet1":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Misc/system.device.location.resolvecivicaddresssync/vb/resolvecivicaddresssync.vb" id="Snippet1":::
]]></format>
</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="coordinate" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="coordinate" /> does not contain a valid latitude and longitude.</exception>
</Docs>
</Member>
<Member MemberName="ResolveAddressAsync">
<MemberSignature Language="C#" Value="public void ResolveAddressAsync (System.Device.Location.GeoCoordinate coordinate);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void ResolveAddressAsync(class System.Device.Location.GeoCoordinate coordinate) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Device.Location.CivicAddressResolver.ResolveAddressAsync(System.Device.Location.GeoCoordinate)" />
<MemberSignature Language="VB.NET" Value="Public Sub ResolveAddressAsync (coordinate As GeoCoordinate)" />
<MemberSignature Language="F#" Value="abstract member ResolveAddressAsync : System.Device.Location.GeoCoordinate -> unit
override this.ResolveAddressAsync : System.Device.Location.GeoCoordinate -> unit" Usage="civicAddressResolver.ResolveAddressAsync coordinate" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual void ResolveAddressAsync(System::Device::Location::GeoCoordinate ^ coordinate);" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.Device.Location.ICivicAddressResolver.ResolveAddressAsync(System.Device.Location.GeoCoordinate)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>System.Device</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="coordinate" Type="System.Device.Location.GeoCoordinate" />
</Parameters>
<Docs>
<param name="coordinate">The <see cref="T:System.Device.Location.GeoCoordinate" /> containing the location to resolve to a civic address.</param>
<summary>Resolves an address asynchronously from a location that is based on latitude and longitude. The call does not block execution of the calling thread while the address is being resolved.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as <xref:System.ArgumentException>, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by <xref:System.Device.Location.CivicAddressResolver.ResolveAddress(System.Device.Location.GeoCoordinate)>.
## Examples
The following program shows how to call <xref:System.Device.Location.CivicAddressResolver.ResolveAddressAsync%2A> to resolve a civic address asynchronously.
:::code language="csharp" source="~/snippets/csharp/System.Device.Location/CivicAddress/Overview/resolvecivicaddressasync.cs" id="Snippet1":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Misc/system.device.location.resolvecivicaddressasync/vb/resolvecivicaddressasync.vb" id="Snippet1":::
]]></format>
</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="coordinate" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="coordinate" /> does not contain a valid latitude and longitude.</exception>
</Docs>
</Member>
<Member MemberName="ResolveAddressCompleted">
<MemberSignature Language="C#" Value="public event EventHandler<System.Device.Location.ResolveAddressCompletedEventArgs> ResolveAddressCompleted;" />
<MemberSignature Language="ILAsm" Value=".event class System.EventHandler`1<class System.Device.Location.ResolveAddressCompletedEventArgs> ResolveAddressCompleted" />
<MemberSignature Language="DocId" Value="E:System.Device.Location.CivicAddressResolver.ResolveAddressCompleted" />
<MemberSignature Language="VB.NET" Value="Public Custom Event ResolveAddressCompleted As EventHandler(Of ResolveAddressCompletedEventArgs) " FrameworkAlternate="netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2" />
<MemberSignature Language="F#" Value="member this.ResolveAddressCompleted : EventHandler<System.Device.Location.ResolveAddressCompletedEventArgs> " Usage="member this.ResolveAddressCompleted : System.EventHandler<System.Device.Location.ResolveAddressCompletedEventArgs> " />
<MemberSignature Language="C++ CLI" Value="public:
 virtual event EventHandler<System::Device::Location::ResolveAddressCompletedEventArgs ^> ^ ResolveAddressCompleted;" />
<MemberSignature Language="VB.NET" Value="Public Event ResolveAddressCompleted As EventHandler(Of ResolveAddressCompletedEventArgs) " FrameworkAlternate="netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1" />
<MemberType>Event</MemberType>
<Implements>
<InterfaceMember>E:System.Device.Location.ICivicAddressResolver.ResolveAddressCompleted</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>System.Device</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.EventHandler<System.Device.Location.ResolveAddressCompletedEventArgs></ReturnType>
</ReturnValue>
<Docs>
<summary>Occurs when the address resolution that was initiated by a call to <see cref="M:System.Device.Location.CivicAddressResolver.ResolveAddressAsync(System.Device.Location.GeoCoordinate)" /> completes.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following program shows how to call <xref:System.Device.Location.CivicAddressResolver.ResolveAddressAsync%2A> to resolve a civic address asynchronously.
:::code language="csharp" source="~/snippets/csharp/System.Device.Location/CivicAddress/Overview/resolvecivicaddressasync.cs" id="Snippet1":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Misc/system.device.location.resolvecivicaddressasync/vb/resolvecivicaddressasync.vb" id="Snippet1":::
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>