Skip to content

ProGuide Installation and Upgrade

uma2526 edited this page May 12, 2021 · 21 revisions
Language:      C#
Subject:       Framework
Contributor:   ArcGIS Pro SDK Team <arcgisprosdk@esri.com>
Organization:  Esri, http://www.esri.com
Date:          3/29/2021
ArcGIS Pro:    2.8
Visual Studio: 2017, 2019

This ProGuide explains how to install, upgrade and uninstall ArcGIS Pro SDK for .NET.

In this topic

Install ArcGIS Pro SDK for .NET

ArcGIS Pro SDK for .NET templates and utilities are available as Visual Studio extensions (.vsix files). You do not need administrative access or elevated user permissions to install ArcGIS Pro SDK for .NET.

To install ArcGIS Pro SDK for .NET, complete the following steps:

  1. Start Visual Studio.
    • Visual Studio 2017: On the Tools menu, choose Extensions and Updates.... This will bring up the Extensions and Update dialog.
    • Visual Studio 2019: On the Extensions menu, choose Manage Extensions. This will bring up the Manage Extensions dialog.
  2. Expand the Online folder on the left and choose Visual Studio Marketplace.
    Online_Option1.png
  3. Type ArcGIS Pro SDK in the search box in the upper right corner. Among the search results found, the items you will need are ArcGIS Pro SDK for .NET and ArcGIS Pro SDK for .NET (Utilities) as shown in the following screen shot:
    Search1.png
  4. Choose the ArcGIS Pro SDK for .NET package and click the Download button.
  5. ArcGIS Pro SDK for .NET will be scheduled for install when Visual Studio windows are closed. Click Close to dismiss the dialog and exit Visual Studio.
    SDK_Install.png
  6. The VSIX Installer dialog will appear. Click Modify to install ArcGIS Pro SDK for .NET. Proceed with the VSIX Install wizard to complete the installation.
    SDK_Install.png
  7. To install ArcGIS Pro SDK for .NET (Utilities) from the Visual Studio Marketplace, choose the ArcGIS Pro SDK for .NET (Utilities) package in the Extensions and Update (Visual Studio 2017) or Manage Extensions (Visual Studio 2019) dialog. Click the Download button. Install the ArcGIS Pro SDK for .NET (Utilities) package in the same manner explained above.
  8. Verify that the ArcGIS Pro SDK for .NET templates and utilities are installed in Visual Studio.
    • Visual Studio 2017: You should see an ArcGIS folder within the set of New Project templates for Visual C# and Visual Basic. ArcGIS_Pro_Addins_CS1.png
    • Visual Studio 2019: Access the Create New Project option from the Visual Studio start window.
      CreateNewProject_VS2019.png
      Filter all the available Project templates by using custom ArcGIS Pro SDK Project Type Filter. You should see ArcGIS Pro SDK templates. ArcGIS_Pro_Addins_VS2019.png Note: After installation, the Manage Extensions (Visual Studio 2019) or Extensions and Update (Visual Studio 2017) dialog box can be used to enable, disable, update, or uninstall the ArcGIS Pro SDK for .NET packages.

See ProGuide: Build your first add-in to learn how to create add-ins to customize and extend ArcGIS Pro.

Upgrade ArcGIS Pro SDK for .NET

Warning: If you have the Automatically update extensions option checked in Visual Studio, you will already have the newer version of ArcGIS Pro SDK for .NET on your machine.

auto-update.png

We recommend that you turn this feature off. With this auto-update extensions feature in Visual Studio, you could get into a state where you're using an older version of ArcGIS Pro with a newer version of ArcGIS Pro SDK (which was upgraded automatically in Visual Studio). If this happens, you will encounter errors when you attempt to create an ArcGIS Pro add-in using the SDK. Enable/disable auto-updates per extension in Tools -> Extensions and Update (Visual Studio 2017) or Extension -> Manage Extensions (Visual Studio 2019). Enable/disable auto-updates at a global level through Tools -> Options.

Note: Auto-update of selected extensions can be turned off. We recommend that you use this feature to turn off the update of ArcGIS Pro SDK for .NET and ArcGIS Pro SDK for .NET (Utilities) extension packages.

turn-off-auto-update.png

If you do not have the Automatically update extensions option checked in Visual Studio, follow these steps to upgrade to the newer version of ArcGIS Pro SDK for .NET:

  1. Start Visual Studio.
    • Visual Studio 2017: On the Tools menu, choose Extensions and Updates.... This will bring up the Extensions and Update dialog.
    • Visual Studio 2019: On the Extensions menu, choose Manage Extensions. This will bring up the Manage Extensions dialog.
  2. Expand the Updates folder on the left and choose Visual Studio Marketplace.
  3. When an update for these products are available, ArcGIS Pro SDK for .NET and ArcGIS Pro SDK for .NET (Utilities) will be listed as packages to update.
  4. Choose ArcGIS Pro SDK for .NET and click the Update button.
  5. ArcGIS Pro SDK for .NET will be scheduled for update when Visual Studio windows are closed. Click Close to dismiss the dialog and exit Visual Studio. The VSIX Installer dialog will appear. Click Modify to update ArcGIS Pro SDK for .NET. Proceed with the VSIX Install wizard to complete the update installation.
  6. Choose the ArcGIS Pro SDK for .NET (Utilities) package from Visual Studio Marketplace. Click the Update button. Update the ArcGIS Pro SDK for .NET (Utilities) package in the same manner.
  7. Verify that the new ArcGIS Pro SDK for .NET templates and utilities are updated in Visual Studio by checking the version of the packages on the Extensions and Updates (Visual Studio 2017) or the Manage Extensions (Visual Studio 2019) dialog box in Visual Studio.
    new-version-vsix.png

Note: There is a known issue with using auto updates in the Visual Studio 2019 Community Edition. Visual Studio 2019 Automatic Update not working

If you encounter this issue you can:

Uninstall ArcGIS Pro SDK for .NET

  1. Start Visual Studio.
    • Visual Studio 2017: On the Tools menu, choose Extensions and Updates.... This will bring up the Extensions and Update dialog.
    • Visual Studio 2019: On the Extensions menu, choose Manage Extensions. This will bring up the Manage Extensions dialog.
  2. Expand the Installed folder on the left and choose All.
  3. Find the ArcGIS Pro SDK for .NET and ArcGIS Pro SDK for .NET (Utilities) packages and click the Uninstall button.
    vsix-uninstall.png

Distribute ArcGIS Pro SDK for .NET using a private gallery

private-gallery.png

You can share ArcGIS Pro SDK for .NET by posting the VSIX packages to a private gallery on the intranet for your organization. Use the instructions from Visual Studio's Private Galleries documentation to set up your own portal from which your users can install ArcGIS Pro SDK for .NET.

You can download ArcGIS Pro SDK for .NET from "My Esri" (http://my.esri.com) or from Visual Studio Marketplace.

Home

Developing with ArcGIS Pro


Framework

    Add-ins

    Configurations

    Customization

    Styling


Content


CoreHost


DataReviewer


Editing


Geodatabase


Geometry

    Relational Operations


Geoprocessing


Layouts

    Reports


Map Authoring

    CIM

    Graphics

    Scene

    Stream

    Voxel


Map Exploration

    Map Tools


Parcel Fabric


Raster


Sharing


Tasks


Utility Network


Workflow Manager


Reference

Clone this wiki locally