Read shapefile metadata

This sample demonstrates how to open a shapefile stored on the device, read metadata that describes the dataset, and display it as a feature layer with default symbology.

Metadata for a shapefile dataset


The shapefile will be downloaded from an ArcGIS Online portal automatically.


// Copyright 2017 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:
// 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.Data;
using Esri.ArcGISRuntime.Mapping;
using Esri.ArcGISRuntime.UI.Controls;
using Foundation;
using System;
using System.IO;
using System.Threading.Tasks;
using UIKit;

namespace ArcGISRuntimeXamarin.Samples.ReadShapefileMetadata
    public class ReadShapefileMetadata : UIViewController
        // Create a MapView control to display a map
        private MapView _myMapView = new MapView();

        // Store the shapefile metadata
        private ShapefileInfo _shapefileMetadata;

        public ReadShapefileMetadata()
            Title = "Read shapefile metadata";

        public override void ViewDidLoad()

            // Create a layout with a map view and a button to show metadata

            // Download (if necessary) and add a local shapefile dataset to the map

        public override void ViewDidLayoutSubviews()

            // Update the UI to account for new layout
            _myMapView.Frame = new CoreGraphics.CGRect(0, 0, View.Bounds.Width, View.Bounds.Height);

        private async void Initialize()
            // Create a new map to display in the map view with a streets basemap
            Map streetMap = new Map(Basemap.CreateStreetsVector());

            // Get the path to the downloaded shapefile
            string filepath = await GetShapefilePath();

            // Open the shapefile
            ShapefileFeatureTable myShapefile = await ShapefileFeatureTable.OpenAsync(filepath);

            // Read metadata about the shapefile and display it in the UI
            _shapefileMetadata = myShapefile.Info;

            // Create a feature layer to display the shapefile
            FeatureLayer newFeatureLayer = new FeatureLayer(myShapefile);

            // Zoom the map to the extent of the shapefile
            _myMapView.SpatialReferenceChanged += async (s, e) =>
                await _myMapView.SetViewpointGeometryAsync(newFeatureLayer.FullExtent);

            // Add the feature layer to the map

            // Show the map in the MapView
            _myMapView.Map = streetMap;

        private async Task<string> GetShapefilePath()
            // This code assumes that you have already installed the file at the specified path.
	    // For more information and examples of using offline data, see
	    // The referenced item can be found at
	    return Path.Combine(System.Environment.GetFolderPath(System.Environment.SpecialFolder.ApplicationData), "TrailBikeNetwork.shp" );

        private void CreateLayout()
            // Add MapView to the page

            // Add a button at the bottom to show metadata dialog
            UIButton metadataButton = new UIButton(UIButtonType.Custom)
                Frame = new CoreGraphics.CGRect(0, View.Bounds.Height - 40, View.Bounds.Width, 40),
                BackgroundColor = UIColor.White

            // Create button to show metadata
            metadataButton.SetTitle("Metadata", UIControlState.Normal);
            metadataButton.SetTitleColor(UIColor.Blue, UIControlState.Normal);
            metadataButton.TouchUpInside += OnMetadataButtonTouch;

            // Add MapView to the page
            View.AddSubviews(_myMapView, metadataButton);

        private void OnMetadataButtonTouch(object sender, EventArgs e)
            // Create a dialog to show metadata values that covers the entire view
            CoreGraphics.CGRect ovBounds = new CoreGraphics.CGRect(0, 60, View.Bounds.Width, View.Bounds.Height);
            ShapefileMetadataDialog metadataDialog = new ShapefileMetadataDialog(ovBounds, 0.05f, UIColor.White, _shapefileMetadata);

            // Add the dialog (will show on top of the map view)

            // Action to decrease the view transparency (will be 100% opaque)
            Action makeOpaqueAction = () => metadataDialog.Alpha = 1.0f;

            // Animate opacity to 100% in one second
            UIView.Animate(1.00, makeOpaqueAction, null);

    // View to display shapefile metadata info
    public class ShapefileMetadataDialog : UIView
        // ImageView to display the shapefile thumbnail
        private UIImageView _shapefileThumbnailImage;

        public ShapefileMetadataDialog(CoreGraphics.CGRect frame, nfloat opacity, UIColor color, ShapefileInfo metadata) : base(frame)
            // Create a semi-transparent overlay with the specified background color
            BackgroundColor = color;
            Alpha = opacity;
            // Variables for space between controls and for control width (height will vary)
            nfloat rowSpace = 5;
            nfloat controlWidth = Frame.Width - 20;

            // Find the center x and y of the view
            nfloat centerX = Frame.Width / 2;
            nfloat centerY = Frame.Height / 2;

            // Find the start x and y for the control layout
            nfloat controlX = centerX - (controlWidth / 2);
            nfloat controlY = 20;

            // Label for credits metadata
            UILabel creditsLabel = new UILabel(new CoreGraphics.CGRect(controlX, controlY, controlWidth, 20));
            creditsLabel.Text = metadata.Credits;
            creditsLabel.TextColor = UIColor.Blue;

            // Adjust the Y position for the next control
            controlY = controlY + 20 + rowSpace;

            // Label for the summary metadata
            UILabel summaryLabel = new UILabel(new CoreGraphics.CGRect(controlX, controlY, controlWidth, 120));
            summaryLabel.LineBreakMode = UILineBreakMode.WordWrap;
            summaryLabel.Lines = 0;
            summaryLabel.Text = metadata.Summary;

            // Adjust the Y position for the next control
            controlY = controlY + 120 + rowSpace;

            // ImageView for metadata thumbnail
            _shapefileThumbnailImage = new UIImageView(new CoreGraphics.CGRect(centerX-80, controlY, 160, 160));

            // Adjust the Y position for the next control
            controlY = controlY + 160 + rowSpace;

            // Metadata tags
            UILabel tagsLabel = new UILabel(new CoreGraphics.CGRect(controlX, controlY, controlWidth, 100));
            tagsLabel.LineBreakMode = UILineBreakMode.WordWrap;
            tagsLabel.Lines = 0;
            tagsLabel.Text = string.Join(",", metadata.Tags);

            // Adjust the Y position for the next control
            controlY = controlY + 100 + rowSpace;

            // Button to hide the dialog
            UIButton hideButton = new UIButton(new CoreGraphics.CGRect(controlX, controlY, controlWidth, 20));
            hideButton.SetTitle("OK", UIControlState.Normal);
            hideButton.SetTitleColor(UIColor.Blue, UIControlState.Normal);
            hideButton.TouchUpInside += (s, e) => { Hide(); };

            // Add the controls
            AddSubviews(creditsLabel, summaryLabel, _shapefileThumbnailImage, tagsLabel, hideButton);

        private async void LoadThumbnail(ShapefileInfo metadata)
            // Asynchronously get the thumbnail image from the metadata
            UIImage thumbnailImage = await Esri.ArcGISRuntime.UI.RuntimeImageExtensions.ToImageSourceAsync(metadata.Thumbnail);

            // Show the image in the UI
            _shapefileThumbnailImage.Image = thumbnailImage;

        // Animate increasing transparency to completely hide the view, then remove it
        public void Hide()
            // Action to make the view transparent
            Action makeTransparentAction = () => Alpha = 0;

            // Action to remove the view
            Action removeViewAction = () => RemoveFromSuperview();

            // Time to complete the animation (seconds)
            double secondsToComplete = 0.75;

            // Animate transparency to zero, then remove the view
            Animate(secondsToComplete, makeTransparentAction, removeViewAction);

In this topic
  1. Instructions
  2. Code