Show / Hide Table of Contents

Class WmsService

An Open Geospatial Consortium (OGC) Web Map Service (WMS).

Inheritance
System.Object
WmsService
Implements
System.ComponentModel.INotifyPropertyChanged
ILoadable
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Esri.ArcGISRuntime.Ogc
Assembly: Esri.ArcGISRuntime.dll
Syntax
public class WmsService : INotifyPropertyChanged, ILoadable
Remarks

The OGC WMS standard is an international specification for requesting geo-registered map images from one or more distributed geospatial databases. The service may be hosted in ArcGIS Enterprise or in a third party server. You can construct a WmsService using the URL for a service's GetCapabilities operation. Once loaded, you can browse its metadata using ServiceInfo and access its layers using the LayerInfos collection.

WMS versions 1.3.0, 1.1.1, and 1.1.0 are supported. The latest supported WMS version is set as the default. If you want to specify a different WMS version, set the VERSION parameter in the GetCapabilities URL for the service. For more information, see Parameters of a WMS GetCapabilities request URL.

Constructors

Name Description
WmsService(Uri)

Initializes a new instance of the WmsService class with the specified service URI.

Properties

Name Description
CustomParameters

Gets the dictionary of custom parameters that are appended to WMS requests.

LoadError

Gets the System.Exception associated with the last load error.

LoadStatus

Gets the load status.

ServiceInfo

Gets the information for browsing and accessing the WmsService content.

Source

Gets the URI of this WMS service.

Version

Gets the version of the WMS specification used when communicating with this service.

Methods

Name Description
CancelLoad()

Cancel loading metadata for the object.

LoadAsync()

Load the metadata for the object asynchronously.

RetryLoadAsync()

Loads or retries loading metadata for the object asynchronously.

Events

Name Description
Loaded

Event that is raised when the object is done loading.

LoadStatusChanged

Event that is raised when the LoadStatus property changes.

Name Description
INotifyPropertyChanged.PropertyChanged

See Also

WmsServiceInfo
WmsLayer

Applies to

TargetVersions
.NET Standard 2.0100.3 - 200.7
.NET100.13 - 200.7
.NET Windows100.13 - 200.7
.NET Android200.0 - 200.7
.NET iOS200.0 - 200.7
.NET Framework100.2.1 - 200.7
Xamarin.Android100.2.1 - 100.15
Xamarin.iOS100.2.1 - 100.15
UWP100.2.1 - 200.7

Relevant samples

WMS service catalog: Connect to a WMS service and show the available layers and sublayers.
In This Article
Back to top Copyright © 2022 Esri.