ArcGIS Runtime SDK for .NET Samples

Generate geodatabase

Generate geodatabase map

// 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:
// 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 Android.App;
using Android.OS;
using Android.Widget;
using ArcGISRuntime.Samples.Managers;
using Esri.ArcGISRuntime.Data;
using Esri.ArcGISRuntime.Geometry;
using Esri.ArcGISRuntime.Mapping;
using Esri.ArcGISRuntime.Symbology;
using Esri.ArcGISRuntime.Tasks;
using Esri.ArcGISRuntime.Tasks.Offline;
using Esri.ArcGISRuntime.UI;
using Esri.ArcGISRuntime.UI.Controls;
using System;
using System.Drawing;
using System.IO;
using System.Linq;
using System.Threading.Tasks;

namespace ArcGISRuntime.Samples.GenerateGeodatabase
        "Generate geodatabase",
        "This sample demonstrates how to take a feature service offline by generating a geodatabase.",
        "1. Pan and zoom to the area you would like to download features for, ensuring that all features are within the rectangle.\n2. Tap on the button. This will start the process of generating the offline geodatabase.\n3. Observe that the sample unregisters the geodatabase. This is best practice when changes won't be edited and synced back to the service.\n\nNote that the basemap will be automatically downloaded from an ArcGIS Online portal.")]
    public class GenerateGeodatabase : Activity
        // URL for a feature service that supports geodatabase generation.
        private Uri _featureServiceUri = new Uri("");

        // Path to the geodatabase file on disk.
        private string _gdbPath;

        // Task to be used for generating the geodatabase.
        private GeodatabaseSyncTask _gdbSyncTask;

        // Job used to generate the geodatabase.
        private GenerateGeodatabaseJob _generateGdbJob;

        // Mapview.
        private MapView myMapView;

        // Generate Button.
        private Button myGenerateButton;

        // Progress bar.
        private ProgressBar myProgressBar;

        protected override void OnCreate(Bundle bundle)
            Title = "Generate geodatabase";

            // Create the UI, setup the control references and execute initialization.

        private void CreateLayout()
            // Create the layout.
            LinearLayout layout = new LinearLayout(this);
            layout.Orientation = Orientation.Vertical;

            // Add the progress bar.
            myProgressBar = new ProgressBar(this);
            myProgressBar.Visibility = Android.Views.ViewStates.Gone;

            // Add the generate button.
            myGenerateButton = new Button(this);
            myGenerateButton.Text = "Generate";
            myGenerateButton.Enabled = false;
            myGenerateButton.Click += GenerateButton_Clicked;

            // Add the mapview.
            myMapView = new MapView(this);

            // Add the layout to the view.

        private async void Initialize()
            // Create a tile cache and load it with the SanFrancisco streets tpk.
                TileCache tileCache = new TileCache(DataManager.GetDataFolder("3f1bbf0ec70b409a975f5c91f363fe7d", "SanFrancisco.tpk"));

                // Create the corresponding layer based on the tile cache.
                ArcGISTiledLayer tileLayer = new ArcGISTiledLayer(tileCache);

                // Create the basemap based on the tile cache.
                Basemap sfBasemap = new Basemap(tileLayer);

                // Create the map with the tile-based basemap.
                Map myMap = new Map(sfBasemap);

                // Assign the map to the MapView.
                myMapView.Map = myMap;

                // Create a new symbol for the extent graphic.
                SimpleLineSymbol lineSymbol = new SimpleLineSymbol(SimpleLineSymbolStyle.Solid, Color.Red, 2);

                // Create graphics overlay for the extent graphic and apply a renderer.
                GraphicsOverlay extentOverlay = new GraphicsOverlay();
                extentOverlay.Renderer = new SimpleRenderer(lineSymbol);

                // Add graphics overlay to the map view.

                // Set up an event handler for when the viewpoint (extent) changes.
                myMapView.ViewpointChanged += MapViewExtentChanged;

                // Create a task for generating a geodatabase (GeodatabaseSyncTask).
                _gdbSyncTask = await GeodatabaseSyncTask.CreateAsync(_featureServiceUri);

                // Add all graphics from the service to the map.
                foreach (var layer in _gdbSyncTask.ServiceInfo.LayerInfos)
                    // Create the ServiceFeatureTable for this particular layer.
                    ServiceFeatureTable onlineTable = new ServiceFeatureTable(new Uri(_featureServiceUri + "/" + layer.Id));

                    // Wait for the table to load.
                    await onlineTable.LoadAsync();

                    // Add the layer to the map's operational layers if load succeeds.
                    if (onlineTable.LoadStatus == Esri.ArcGISRuntime.LoadStatus.Loaded)
                        myMap.OperationalLayers.Add(new FeatureLayer(onlineTable));

                // Update the graphic - in case user doesn't interact with the map.

                // Enable the generate button now that the sample is ready.
                myGenerateButton.Enabled = true;
            catch (Exception ex)

        private void UpdateMapExtent()
            // Return if mapview is null.
            if (myMapView == null) { return; }

            // Get the new viewpoint.
            Viewpoint myViewPoint = myMapView.GetCurrentViewpoint(ViewpointType.BoundingGeometry);

            // Return if viewpoint is null.
            if (myViewPoint == null) { return; }

            // Get the updated extent for the new viewpoint.
            Envelope extent = myViewPoint.TargetGeometry as Envelope;

            // Return if extent is null.
            if (extent == null) { return; }

            // Create an envelope that is a bit smaller than the extent.
            EnvelopeBuilder envelopeBldr = new EnvelopeBuilder(extent);

            // Get the (only) graphics overlay in the map view.
            var extentOverlay = myMapView.GraphicsOverlays.FirstOrDefault();

            // Return if the extent overlay is null.
            if (extentOverlay == null) { return; }

            // Get the extent graphic.
            Graphic extentGraphic = extentOverlay.Graphics.FirstOrDefault();

            // Create the extent graphic and add it to the overlay if it doesn't exist.
            if (extentGraphic == null)
                extentGraphic = new Graphic(envelopeBldr.ToGeometry());
                // Otherwise, update the graphic's geometry.
                extentGraphic.Geometry = envelopeBldr.ToGeometry();

        private async Task StartGeodatabaseGeneration()
            // Update the geodatabase path.
            _gdbPath = $"{Path.GetTempFileName()}.geodatabase";

            // Create a task for generating a geodatabase (GeodatabaseSyncTask).
            _gdbSyncTask = await GeodatabaseSyncTask.CreateAsync(_featureServiceUri);

            // Get the current extent of the red preview box.
            Envelope extent = myMapView.GraphicsOverlays.First().Graphics.First().Geometry as Envelope;

            // Get the default parameters for the generate geodatabase task.
            GenerateGeodatabaseParameters generateParams = await _gdbSyncTask.CreateDefaultGenerateGeodatabaseParametersAsync(extent);

            // Create a generate geodatabase job.
            _generateGdbJob = _gdbSyncTask.GenerateGeodatabase(generateParams, _gdbPath);

            // Handle the progress changed event (to show progress bar).
            _generateGdbJob.ProgressChanged += ((sender, e) =>

            // Show the progress bar.
            myProgressBar.Visibility = Android.Views.ViewStates.Visible;

            // Start the job.

            // Wait for the geodatabase.
            Geodatabase resultGdb = await _generateGdbJob.GetResultAsync();

            // Hide the progress bar.
            myProgressBar.Visibility = Android.Views.ViewStates.Gone;

            // Do the rest of the work.
            await HandleGenerationCompleted(_generateGdbJob, resultGdb);

        private async Task HandleGenerationCompleted(GenerateGeodatabaseJob job, Geodatabase resultGdb)
            JobStatus status = job.Status;

            // If the job completed successfully, add the geodatabase data to the map.
            if (status == JobStatus.Succeeded)
                // Clear out the existing layers.

                // Loop through all feature tables in the geodatabase and add a new layer to the map.
                foreach (GeodatabaseFeatureTable table in resultGdb.GeodatabaseFeatureTables)
                    // Create a new feature layer for the table.
                    FeatureLayer _layer = new FeatureLayer(table);

                    // Add the new layer to the map.
                // Best practice is to unregister the geodatabase.
                await _gdbSyncTask.UnregisterGeodatabaseAsync(resultGdb);

                // Tell the user that the geodatabase was unregistered.
                ShowStatusMessage("Since no edits will be made, the local geodatabase has been unregistered per best practice.");

                // Re-enable the generate button.
                myGenerateButton.Enabled = true;

            // See if the job failed.
            if (status == JobStatus.Failed)
                // Create a message to show the user.
                string message = "Generate geodatabase job failed";

                // Show an error message (if there is one).
                if (job.Error != null)
                    message += ": " + job.Error.Message;
                    // If no error, show messages from the job.
                    var m = from msg in job.Messages select msg.Message;
                    message += ": " + string.Join<string>("\n", m);

                // Show error message.

                // Re-enable the generate button.
                myGenerateButton.Enabled = true;

        private void ShowStatusMessage(string message)
            // Display the message to the user.
            var builder = new AlertDialog.Builder(this);

        private async void GenerateButton_Clicked(object sender, EventArgs e)
                // Disable the generate button.
                myGenerateButton.Enabled = false;

                // Call the geodatabase generation method.
                await StartGeodatabaseGeneration();
            catch (Exception ex)

        private void MapViewExtentChanged(object sender, EventArgs e)
            // Call the map extent update method.

        private void UpdateProgressBar()
            // Due to the nature of the threading implementation,
            //     the dispatcher needs to be used to interact with the UI.
            RunOnUiThread(() =>
                // Update the progress bar value.
                myProgressBar.Progress = _generateGdbJob.Progress;

In this topic
  1. Code