Click or drag to resize

MgrsGrid Class

A class that represents the display of the Military Grid Reference System (MGRS) on the map view.
Inheritance Hierarchy

Namespace:  Esri.ArcGISRuntime.UI
Assembly:  Esri.ArcGISRuntime (in Esri.ArcGISRuntime.dll) Version: 100.11.0
Syntax
public sealed class MgrsGrid : Grid

The MgrsGrid type exposes the following members.

Constructors
  NameDescription
Public methodCode exampleMgrsGrid
Initializes a new instance of the MgrsGrid class.
Top
Properties
  NameDescription
Public propertyCode exampleIsLabelVisible
Gets or sets a value indicating whether grid's labels are visible.
(Inherited from Grid.)
Public propertyCode exampleIsVisible
Gets or sets a value indicating whether the grid is visible.
(Inherited from Grid.)
Public propertyLabelOffset
Gets or sets the grid's text label offset from the edge of the map view in DIPS.
(Inherited from Grid.)
Public propertyCode exampleLabelPosition
Gets or sets the positioning of the grid's labels
(Inherited from Grid.)
Public propertyLabelUnit
Gets or sets the units used for labeling the grid.
Public propertyCode exampleLevelCount
Gets the number of levels of resolution supported by the grid. The line and label style can be set for each of these resolution levels.
(Inherited from Grid.)
Top
Methods
  NameDescription
Public methodGetLineSymbol
Returns the line symbol used for the grid lines at the given resolution level.
(Inherited from Grid.)
Public methodGetTextSymbol
Returns the text symbol used for the grid labels at the given resolution level.
(Inherited from Grid.)
Public methodSetLineSymbol
Sets the line symbol used for the grid lines at the given resolution level.
(Inherited from Grid.)
Public methodSetTextSymbol
Sets the text symbol used for the grid labels at the given resolution level.
(Inherited from Grid.)
Top
Remarks
MGRSGrid inherits from Grid and adds a property for the label unit to use.
Examples

WPF

Example Name: DisplayGrid

Display coordinate system grids including Latitude/Longitude, MGRS, UTM and USNG on a map view. Also, toggle label visibility and change the color of grid lines and grid labels.

Code example screen shot.

C#
// Copyright 2018 Esri.
// 
// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
// You may obtain a copy of the License at: http://www.apache.org/licenses/LICENSE-2.0
// 
// Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific
// language governing permissions and limitations under the License.

using Esri.ArcGISRuntime.Mapping;
using Esri.ArcGISRuntime.Symbology;
using Esri.ArcGISRuntime.UI;
using System;
using System.Windows;
using System.Windows.Controls;
using Esri.ArcGISRuntime.Geometry;
using Colors = System.Drawing.Color;
using Grid = Esri.ArcGISRuntime.UI.Grid;

namespace ArcGISRuntime.WPF.Samples.DisplayGrid
{
    [ArcGISRuntime.Samples.Shared.Attributes.Sample(
        name: "Display grid",
        category: "MapView",
        description: "Display coordinate system grids including Latitude/Longitude, MGRS, UTM and USNG on a map view. Also, toggle label visibility and change the color of grid lines and grid labels.",
        instructions: "Select type of grid from the types (LatLong, MGRS, UTM and USNG) and modify its properties like label visibility, grid line color, and grid label color. Press the button to apply these settings.",
        tags: new[] { "MGRS", "USNG", "UTM", "coordinates", "degrees", "graticule", "grid", "latitude", "longitude", "minutes", "seconds" })]
    public partial class DisplayGrid
    {
        public DisplayGrid()
        {
            InitializeComponent();

            Initialize();
        }

        private void Initialize()
        {
            // Set up the map view with a basemap.
            MyMapView.Map = new Map(BasemapStyle.ArcGISImagery);

            // Configure the UI options.
            GridTypeCombo.ItemsSource = new[] {"LatLong", "MGRS", "UTM", "USNG"};
            Colors[] colorItemsSource = {Colors.Red, Colors.Green, Colors.Blue, Colors.White, Colors.Purple};
            GridColorCombo.ItemsSource = colorItemsSource;
            LabelColorCombo.ItemsSource = colorItemsSource;
            HaloColorCombo.ItemsSource = colorItemsSource;
            LabelPositionCombo.ItemsSource = Enum.GetNames(typeof(GridLabelPosition));
            LabelFormatCombo.ItemsSource = Enum.GetNames(typeof(LatitudeLongitudeGridLabelFormat));
            ComboBox[] boxes = {GridTypeCombo, GridColorCombo, LabelColorCombo, HaloColorCombo, LabelPositionCombo, LabelFormatCombo};
            foreach (ComboBox combo in boxes)
            {
                combo.SelectedIndex = 0;
            }

            // Update the halo color so it isn't the same as the text color.
            HaloColorCombo.SelectedIndex = 3;

            // Subscribe to change events so the label format combo can be disabled as necessary.
            GridTypeCombo.SelectionChanged += (o, e) =>
            {
                LabelFormatCombo.IsEnabled = GridTypeCombo.SelectedItem.ToString() == "LatLong";
            };

            // Subscribe to the button click event.
            ApplySettingsButton.Click += ApplySettingsButton_Click;

            // Enable the action button.
            ApplySettingsButton.IsEnabled = true;

            // Zoom to a default scale that will show the grid labels if they are enabled.
            MyMapView.SetViewpointCenterAsync(
                new MapPoint(-7702852.905619, 6217972.345771, SpatialReferences.WebMercator), 23227);

            // Apply default settings.
            ApplySettingsButton_Click(this, null);
        }

        private void ApplySettingsButton_Click(object sender, RoutedEventArgs e)
        {
            Grid grid;

            // First, update the grid based on the type selected.
            switch (GridTypeCombo.SelectedValue.ToString())
            {
                case "LatLong":
                    grid = new LatitudeLongitudeGrid();
                    // Apply the label format setting.
                    string selectedFormatString = LabelFormatCombo.SelectedValue.ToString();
                    ((LatitudeLongitudeGrid) grid).LabelFormat =
                        (LatitudeLongitudeGridLabelFormat) Enum.Parse(typeof(LatitudeLongitudeGridLabelFormat),
                            selectedFormatString);
                    break;

                case "MGRS":
                    grid = new MgrsGrid();
                    break;

                case "UTM":
                    grid = new UtmGrid();
                    break;
                case "USNG":
                default:
                    grid = new UsngGrid();
                    break;
            }

            // Next, apply the label visibility setting.
            grid.IsLabelVisible = LabelVisibilityCheckbox.IsChecked.Value;
            grid.IsVisible = GridVisibilityCheckbox.IsChecked.Value;

            // Next, apply the grid color and label color settings for each zoom level.
            for (long level = 0; level < grid.LevelCount; level++)
            {
                // Set the line symbol.
                Symbol lineSymbol = new SimpleLineSymbol(SimpleLineSymbolStyle.Solid,
                    (Colors) GridColorCombo.SelectedValue, 2);
                grid.SetLineSymbol(level, lineSymbol);

                // Set the text symbol.
                Symbol textSymbol = new TextSymbol
                {
                    Color = (Colors) LabelColorCombo.SelectedValue,
                    OutlineColor = (Colors) HaloColorCombo.SelectedValue,
                    Size = 16,
                    HaloColor = (Colors) HaloColorCombo.SelectedValue,
                    HaloWidth = 3
                };
                grid.SetTextSymbol(level, textSymbol);
            }

            // Next, apply the label position setting.
            grid.LabelPosition =
                (GridLabelPosition) Enum.Parse(typeof(GridLabelPosition), LabelPositionCombo.SelectedValue.ToString());

            // Apply the updated grid.
            MyMapView.Grid = grid;
        }
    }
}
XAML
<UserControl
    x:Class="ArcGISRuntime.WPF.Samples.DisplayGrid.DisplayGrid"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
    xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
    xmlns:esri="http://schemas.esri.com/arcgis/runtime/2013"
    mc:Ignorable="d"
    d:DesignHeight="300" d:DesignWidth="300">
    <UserControl.Resources>
        <Style TargetType="ComboBox">
            <Setter Property="Margin" Value="5" />
        </Style>
        <Style TargetType="Button">
            <Setter Property="Margin" Value="5" />
        </Style>
    </UserControl.Resources>
    <Grid>
        <esri:MapView x:Name="MyMapView" />
        <Border Style="{StaticResource BorderStyle}">
            <Grid>
                <Grid.RowDefinitions>
                    <RowDefinition Height="Auto" />
                    <RowDefinition Height="Auto" />
                    <RowDefinition Height="Auto" />
                    <RowDefinition Height="Auto" />
                    <RowDefinition Height="Auto" />
                    <RowDefinition Height="Auto" />
                    <RowDefinition Height="Auto" />
                    <RowDefinition Height="Auto" />
                    <RowDefinition Height="Auto" />
                </Grid.RowDefinitions>
                <Grid.ColumnDefinitions>
                    <ColumnDefinition Width="*" />
                    <ColumnDefinition Width="2*" />
                </Grid.ColumnDefinitions>
                <!-- Labels -->
                <Label Content="Grid type"
                       Grid.Row="0" Grid.Column="0" />
                <Label Content="Show grid"
                       Grid.Row="1" Grid.Column="0" />
                <Label Content="Show labels"
                       Grid.Row="2" Grid.Column="0" />
                <Label Content="Grid color"
                       Grid.Row="3" Grid.Column="0" />
                <Label Content="Label color"
                       Grid.Row="4" Grid.Column="0" />
                <Label Content="Halo color"
                       Grid.Row="5" Grid.Column="0" />
                <Label Content="Label position"
                       Grid.Row="6" Grid.Column="0" />
                <Label Content="Label format"
                       Grid.Row="7" Grid.Column="0" />
                <!-- Inputs -->
                <ComboBox x:Name="GridTypeCombo"
                          Grid.Row="0" Grid.Column="1" />
                <CheckBox x:Name="GridVisibilityCheckbox"
                          IsChecked="True" Margin="5"
                          Grid.Row="1" Grid.Column="1" />
                <CheckBox x:Name="LabelVisibilityCheckbox"
                          IsChecked="True" Margin="5"
                          Grid.Row="2" Grid.Column="1" />
                <ComboBox x:Name="GridColorCombo"
                          Grid.Row="3" Grid.Column="1" />
                <ComboBox x:Name="LabelColorCombo"
                          Grid.Row="4" Grid.Column="1" />
                <ComboBox x:Name="HaloColorCombo"
                          Grid.Row="5" Grid.Column="1" />
                <ComboBox x:Name="LabelPositionCombo"
                          Grid.Row="6" Grid.Column="1" />
                <ComboBox x:Name="LabelFormatCombo"
                          Grid.Row="7" Grid.Column="1" />
                <!-- Apply -->
                <Button x:Name="ApplySettingsButton"
                        Grid.Row="8" Grid.Column="0" Grid.ColumnSpan="2"
                        Content="Apply settings"
                        IsEnabled="False" />
            </Grid>
        </Border>
    </Grid>
</UserControl>
See Also
Additional Examples
Hyperlink to ExampleDescription
DisplayGridDisplay coordinate system grids including Latitude/Longitude, MGRS, UTM and USNG on a map view. Also, toggle label visibility and change the color of grid lines and grid labels.