WmsLayer Class

Provides information about a single layer obtained from a Web Map Service Provider.

Namespace: DevExpress.XtraMap

Assembly: DevExpress.XtraMap.v18.1.dll

Declaration

C#

public class WmsLayer :
    IWmsLayer

VB.NET

Public Class WmsLayer
    Implements IWmsLayer

Related API Members

The following members accept/return WmsLayer objects:

• WmsDataProvider.ActiveLayer
• WmsLayerCollection.Item[Int32]

Remarks

Available layers are supplied to a Map control using the CapabilitiesResponsedEventArgs.Layers collection.

Example

This example demonstrates how to receive information from a Web Map Service using the WmsDataProvider.ResponseCapabilities event handler.

To do this, use the CapabilitiesResponsedEventArgs arguments of the event to specify a WMS active layer and obtain the required information.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-obtain-data-on-the-responsecapabilities-event-t359144

Form1.cs

using DevExpress.XtraMap;
using System.Windows.Forms;

namespace ResponseCapabilitiesHandler {
    public partial class Form1 : Form {
        ImageLayer WmsLayer {
            get { return (ImageLayer)mapControl.Layers["WmsImageLayer"]; }
        }
        WmsDataProvider Provider {
            get { return WmsLayer.DataProvider as WmsDataProvider; }
        }
        public Form1() {
            InitializeComponent();
        }
        private void Form1_Load(object sender, System.EventArgs e) {
            // Handle the ResponseCapabilities event.
            Provider.ResponseCapabilities += OnResponseCapabalities;
        }
        void OnResponseCapabalities(object sender, CapabilitiesResponsedEventArgs e) {
            // Specify an active layer for the map control.
            Provider.ActiveLayerName = e.Layers[0].Name;
            // Recieve information on the active layer.
            label1.Text = string.Format("Layer name: {0}, Layer title: {1}",  e.Layers[0].Name, e.Layers[0].Title);           
        }
    }
}

Form1.vb

Imports DevExpress.XtraMap
Imports System.Windows.Forms

Namespace ResponseCapabilitiesHandler
    Partial Public Class Form1
        Inherits Form

        Private ReadOnly Property WmsLayer() As ImageLayer
            Get
                Return CType(mapControl.Layers("WmsImageLayer"), ImageLayer)
            End Get
        End Property
        Private ReadOnly Property Provider() As WmsDataProvider
            Get
                Return TryCast(WmsLayer.DataProvider, WmsDataProvider)
            End Get
        End Property
        Public Sub New()
            InitializeComponent()
        End Sub
        Private Sub Form1_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles MyBase.Load
            ' Handle the ResponseCapabilities event.
            AddHandler Provider.ResponseCapabilities, AddressOf OnResponseCapabalities
        End Sub
        Private Sub OnResponseCapabalities(ByVal sender As Object, ByVal e As CapabilitiesResponsedEventArgs)
            ' Specify an active layer for the map control.
            Provider.ActiveLayerName = e.Layers(0).Name
            ' Recieve information on the active layer.
            label1.Text = String.Format("Layer name: {0}, Layer title: {1}", e.Layers(0).Name, e.Layers(0).Title)
        End Sub
    End Class
End Namespace

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the WmsLayer class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-obtain-a-collection-of-available-wms-layers-in-the-rensponsecapabilities-event-hand-t359209/CS/WmsDataProviderExample/Form1.cs#L27

private void OnGetCellValue(object sender, VirtualTreeGetCellValueInfo e) {
    WmsLayer layer = e.Node as WmsLayer;
    if (layer == null) return;

VB.NET

how-to-obtain-a-collection-of-available-wms-layers-in-the-rensponsecapabilities-event-hand-t359209/VB/WmsDataProviderExample/Form1.vb#L37

Private Sub OnGetCellValue(ByVal sender As Object, ByVal e As VirtualTreeGetCellValueInfo) Handles tlLayers.VirtualTreeGetCellValue
    Dim layer As WmsLayer = TryCast(e.Node, WmsLayer)
    If layer Is Nothing Then

Inheritance

Object

WmsLayer