Install and set up

ArcGIS Runtime for .NET has APIs for developing apps for Windows Presentation Foundation (WPF), Universal Windows Platform (UWP), Xamarin.Android, Xamarin.iOS, and Xamarin Forms.

To bring ArcGIS Runtime functionality into your Visual Studio project, reference the appropriate NuGet packages. You can reference these packages from an online source (such as nuget.org) or from packages installed locally on your machine. A set of project templates, available with the ArcGIS Runtime Visual Studio extension (Windows only), includes the required NuGet package references for each supported platform.

Reference online ArcGIS Runtime NuGet packages

ArcGIS Runtime SDK NuGet packages are hosted on NuGet.org. If you have an internet connection, you can access these packages and add them to your Visual Studio project without having to install anything locally.

  1. Open the NuGet Package Manager (Project > Manage NuGet Packages, for example).

  2. Choose the Browse tab in the manager and the nuget.org package source.

  3. Type "ArcGIS Runtime" in the Search text box. You will see several matches (for various versions and platforms).

    Visual Studio nuget selection

  4. Select the most recent version package for your platform. Click Install to add the package to your project.

  5. Choose OK to proceed with the installation and then I Accept to accept the license agreement.

After adding the package, you'll be able to work with the components in ArcGIS Runtime SDK for .NET.

Install the full Visual Studio extension

ArcGIS Runtime API for .NET provides a Visual Studio Extension (.vsix file) with project templates and NuGet packages for supported platforms. Installing the extension will add the Visual Studio templates and configure a local NuGet package source. If you want to add the ArcGIS Runtime NuGet packages from an online source (NuGet.org), there is no need to download and install them locally. The Visual Studio templates, however, are only available by installing the extension (the extension is not available on Visual Studio for Mac).

For developing ArcGIS Runtime apps with Visual Studio for Windows, you can download and install the ArcGIS Visual Studio extension. The extension provides a set of project templates for use in Visual Studio as well as ArcGIS Runtime NuGet packages for all supported platforms.

If you are developing in an environment that doesn't have reliable connectivity or has restricted online access, you may want to have the ArcGIS Runtime NuGet packages available locally. If not, you might want to only install the Visual Studio templates.

Download Visual Studio extension
  1. Download the Visual Studio extension from your dashboard. You will need to log in with your ArcGIS developer account.

  2. Save the file to a location accessible from your development machine.

  3. Double-click the downloaded file to extract the setup files and start the install.

  4. Chose the product(s) on which to install the extension (Visual Studio 2019, for example). You will only see supported versions of Visual Studio as options. Click Install to accept the license terms. The install will start for all products you selected.

    Visual Studio installation

  5. When complete, you will see an installation confirmation for the selected products. Click Close and make sure to close and restart any open instances of Visual Studio.

  6. To use a project template from the extension, start Visual Studio and choose to create a new project. For the supported project types, you will see an ArcGIS Runtime SDK template.

    Visual Studio ArcGIS templates

  7. To add a local NuGet package, open the NuGet Package Manager (Project > Manage NuGet Packages, for example). Choose the Browse tab in the manager and the local Esri package source (configured by the Visual Studio extension installer). Select the appropriate package for your project and click Install to add the package to your project.

    Visual Studio ArcGIS templates

Install Visual Studio templates only

For developing ArcGIS Runtime apps with Visual Studio for Windows, you can install the ArcGIS project templates without downloading the full extension (with the locally-installed NuGet packages). The project templates use a Model-View-ViewModel (MVVM) design pattern and reference all required NuGet packages for each platform.

  1. In Visual Studio for Windows, choose Extensions > Manage Extensions to show the Manage Extensions dialog.

  2. In the Search text box, type "ArcGIS Runtime". You will see a few matches, including augmented reality (AR) templates for ArcGIS Runtime.

  3. Select the ArcGIS Runtime SDK for .NET - Templates extension and choose Download. The extension will download quickly and a message will indicate that the extension will be installed when you restart.

    Visual Studio templates

  4. Close the Manage Extension dialog.

  5. Choose File > Exit to close Visual Studio and install the extension.

  6. Click Modify in the VSIX Installer dialog that appears when Visual Studio closes.

  7. When the installation finishes, click Close in the installer dialog.

  8. The next time you choose to create a new project in Visual Studio, you will see ArcGIS project templates for all available platforms.

    Visual Studio ArcGIS templates

Additional downloads

You can do many things with this API. Here are a few things to consider.

Sample code

See sample code to review other things you can do in your Runtime apps.

A compiled Windows desktop (WPF) version of the sample viewer is available on the Microsoft Store. Before running the application, please refer to the system requirements to ensure your machine can run the sample viewer application properly.

ArcGIS Runtime API for .NET Toolkit

The ArcGIS Runtime SDK for .NET Toolkit contains controls and utilities to simplify your app development. For example:

  • Compass: A control that shows orientation when a map is rotated
  • Legend: Displays a legend for a single layer in your map (and optionally for its sublayers)
  • MeasureToolbar: Tools for measuring geographic area or distance
  • PopupViewer: Allows you to display details and media, edit attributes, geometry and related records, and manage the attachments of features and graphics (popups are defined in the popup property of features and graphics)
  • ScaleLine: A scale bar that displays the current scale of the map
  • TableOfContents (Preview, WPF only): A tree view that displays all layers contained in a map, optionally including legend information
  • TimeSlider: A control that allows the user to interactively define a temporal range (time extent) and to animate time moving forward or backward. It can be used to manipulate the time extent in a MapView or SceneView

The toolkit is an open source project maintained by the ArcGIS Runtime SDK for .NET team. You can include the toolkit in your project as a NuGet package or download the source code from the GitHub repository and build it locally.

StreetMap Premium

If you want to use StreetMap Premium data (the StreetMap Premium extension), download the demonstration data from the downloads page for development and testing. Please contact Esri Customer Service for access to a region of your choice for development and testing or to license StreetMap Premium data for deployment.

Supplemental data

If your app uses grid-based transformations, download supporting Projection Engine files from the downloads page.

If you want to work with Electronic Navigational Charts (ENC), add the Esri.ArcGISRuntime.Hydrography NuGet package to your app, or download the hydrography directory from the downloads page.

Local Server

If you want to run offline geoprocessing tasks in your app, install local server following the steps in Local Server.

Next steps