Install and set up

ArcGIS Runtime for .NET has APIs for developing apps targeting the application platforms: Windows Presentation Foundation (WPF), Windows UI Library (WinUI), 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

Additional sources of sample code, data, and tools are available to enhance your ArcGIS Runtime development projects. You can even download this guide as stand-alone developer documentation.

Sample code

Get hands-on sample code that illustrates a variety of powerful ArcGIS Runtime capabilities that you can add to your own applications. Search for samples and browse the relevant code in the samples documentation or download the code from the samples repository and run them locally.

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, an open source project maintained by the ArcGIS Runtime SDK for .NET team, contains controls and utilities to simplify your app development. 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.

Local Server

Local Server enables you to run offline geoprocessing tasks to provide advanced spatial analysis and data manipulation in your applications. These tasks work in the same way as geoprocessing tasks running on ArcGIS Enterprise. If you want to run offline geoprocessing tasks in your app, install local server following the steps in Local Server.

Stand-alone developer documentation

You can download the developer documentation (for any ArcGIS Runtime API) as an archive from the downloads page. The archive contains instructions to serve the documentation from a local web server so you can access it without a connection to the internet. The stand-alone documentation includes the developer guide, API reference, tutorials, and samples documentation. This documentation is designed to run on a local stand-alone computer or on an internal network and not on the public internet.

To serve the documentation locally:

  • Download the documentation for the ArcGIS Runtime API(s) you want to use. The downloaded files are in a .zip archive format.
  • Extract the archive to a local folder. The extracted archive has two subfolders: public and install.
  • Open the README.md file in the install folder and follow the instructions for your chosen web server.

Supplemental data

StreetMap Premium

StreetMap Premium for ArcGIS Runtime provides enriched street data, which powers a high-quality cartographic maps and high-quality search, geocoding, and route analysis. StreetMap Premium maps are consistent across all regions of the world and can be taken offline for disconnected use; they can simultaneously fulfill the need for an address locator, street network dataset, and basemap in your app.

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.

Projection Engine data

Datum transformations are used when geometries must be projected from one spatial reference to another when there is a difference in the datum that underlies the two spatial references. Datum transformations can be mathematically defined (equation-based transformations), or may rely on external supporting files (grid-based transformations). Certain Projection Engine data files must be present when you use a grid-based transformation in your app; attempting to use a transformation with missing Projection Engine files will cause an error. The API can detect whether the necessary files are available on the local file system.

If your app requires grid-based transformations, you can download supporting Projection Engine files from the downloads page. See the Spatial references topic for more information about working with coordinate systems, projections, and datum transformations.

Electronic Navigational Charts (ENC)

Electronic navigational charts (ENCs) are georeferenced vector datasets for the visualization and analysis of hydrographic and maritime information. ArcGIS Runtime supports ENCs that conform to the International Hydrographic Organization (IHO) S-57 standard.

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.

See the Display electronic navigational charts topic for more information about working with ENC data.

Next steps

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.