WmsDataProvider.ActiveLayerName Property

Gets or sets the active layer name retrieved from a Web Map Service.

Namespace: DevExpress.XtraMap

Assembly: DevExpress.XtraMap.v19.2.dll

Declaration

C#

[DefaultValue("")]
public string ActiveLayerName { get; set; }

VB.NET

<DefaultValue("")>
Public Property ActiveLayerName As String

Property Value

Type	Default	Description
String	String.Empty	A String value specifying the layer name.

Example

This example demonstrates how to obtain a collection of layers supported by the Web Map Service.

To do this, use the WmsDataProvider.ResponseCapabilities event arguments to obtain the CapabilitiesResponsedEventArgs.Layers collection.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-obtain-a-collection-of-available-wms-layers-in-the-rensponsecapabilities-event-hand-t359209

Form1.cs

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

namespace WmsDataProviderExample {
    public partial class Form1 : Form {
        ImageLayer WmsLayer { get { return mapControl.Layers["WmsLayer"] as ImageLayer; } }
        WmsDataProvider Provider { get { return WmsLayer.DataProvider as WmsDataProvider; } }

        public Form1() {
            InitializeComponent();
        }
        private void Form1_Load(object sender, EventArgs e) {
            // Specify a server URI.
            Provider.ServerUri = "http://INSERT_YOUR_SERVER_URI";
            // Handle the ResponseCapabilities event.
            Provider.ResponseCapabilities += OnResponseCapabalities;
        }

        void OnResponseCapabalities(object sender, CapabilitiesResponsedEventArgs e) {
            tlLayers.DataSource = e.Layers;
        }

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

            if (e.Column.FieldName == "LayerName") {
                e.CellData = layer.Title;
            }
        }

        private void OnGetChildNodes(object sender, VirtualTreeGetChildNodesInfo e) {
            WmsLayerCollection layers = e.Node as WmsLayerCollection;
            if (layers != null) {
                e.Children = layers.ToList();
            }
            WmsLayer layer = e.Node as WmsLayer;
            if (layer != null) {
                e.Children = layer.Children.ToList();
            }
        }

        private void OnFocusedNodeChanged(object sender, FocusedNodeChangedEventArgs e) {
            WmsLayer layer = tlLayers.GetDataRecordByNode(e.Node) as WmsLayer;
            if (layer == null) return;
            Provider.ActiveLayerName = layer.Name;
            mapControl.ZoomToRegion(layer.LeftTop, layer.RightBottom, 0.15);
        }
    }
}

Form1.vb

Imports DevExpress.XtraMap
Imports DevExpress.XtraTreeList
Imports System
Imports System.Linq
Imports System.Windows.Forms

Namespace WmsDataProviderExample
    Partial Public Class Form1
        Inherits Form

        Private ReadOnly Property WmsLayer() As ImageLayer
            Get
                Return TryCast(mapControl.Layers("WmsLayer"), 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 EventArgs) Handles MyBase.Load
            ' Specify a server URI.
            Provider.ServerUri = "http://INSERT_YOUR_SERVER_URI"
            ' Handle the ResponseCapabilities event.
            AddHandler Provider.ResponseCapabilities, AddressOf OnResponseCapabalities
        End Sub

        Private Sub OnResponseCapabalities(ByVal sender As Object, ByVal e As CapabilitiesResponsedEventArgs)
            tlLayers.DataSource = e.Layers
        End Sub

        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
                Return
            End If

            If e.Column.FieldName = "LayerName" Then
                e.CellData = layer.Title
            End If
        End Sub

        Private Sub OnGetChildNodes(ByVal sender As Object, ByVal e As VirtualTreeGetChildNodesInfo) Handles tlLayers.VirtualTreeGetChildNodes
            Dim layers As WmsLayerCollection = TryCast(e.Node, WmsLayerCollection)
            If layers IsNot Nothing Then
                e.Children = layers.ToList()
            End If
            Dim layer As WmsLayer = TryCast(e.Node, WmsLayer)
            If layer IsNot Nothing Then
                e.Children = layer.Children.ToList()
            End If
        End Sub

        Private Sub OnFocusedNodeChanged(ByVal sender As Object, ByVal e As FocusedNodeChangedEventArgs) Handles tlLayers.FocusedNodeChanged
            Dim layer As WmsLayer = TryCast(tlLayers.GetDataRecordByNode(e.Node), WmsLayer)
            If layer Is Nothing Then
                Return
            End If
            Provider.ActiveLayerName = layer.Name
            mapControl.ZoomToRegion(layer.LeftTop, layer.RightBottom, 0.15)
        End Sub
    End Class
End Namespace

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ActiveLayerName property.

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-monitor-errors-using-the-error-event-handler-t361988/CS/MapErrorEvent/Form1.cs#L16

provider.ServerUri = "http://YOUR_SERVER_URI";
provider.ActiveLayerName = "ACTIVE_LAYER_NAME";
imageLayer.Error += OnError;

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

if (layer == null) return;
Provider.ActiveLayerName = layer.Name;
mapControl.ZoomToRegion(layer.LeftTop, layer.RightBottom, 0.15);

how-to-obtain-data-on-the-responsecapabilities-event-t359144/CS/ResponseCapabilitiesHandler/Form1.cs#L21

// Specify an active layer for the map control.
Provider.ActiveLayerName = e.Layers[0].Name;
// Recieve information on the active layer.

VB.NET

how-to-monitor-errors-using-the-error-event-handler-t361988/VB/MapErrorEvent/Form1.vb#L18

provider.ServerUri = "http://YOUR_SERVER_URI"
provider.ActiveLayerName = "ACTIVE_LAYER_NAME"
AddHandler imageLayer.Error, AddressOf OnError

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

End If
Provider.ActiveLayerName = layer.Name
mapControl.ZoomToRegion(layer.LeftTop, layer.RightBottom, 0.15)

how-to-obtain-data-on-the-responsecapabilities-event-t359144/VB/ResponseCapabilitiesHandler/Form1.vb#L27

' Specify an active layer for the map control.
Provider.ActiveLayerName = e.Layers(0).Name
' Recieve information on the active layer.