ProGuide Installation and Upgrade

Uma Harano edited this page Jun 26, 2018 · 13 revisions
Language:      C# and Visual Basic
Subject:       Framework
Contributor:   ArcGIS Pro SDK Team <arcgisprosdk@esri.com>
Organization:  Esri, http://www.esri.com
Date:          6/7/2018
ArcGIS Pro:    2.2
Visual Studio: 2015, 2017

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

In this topic

Important
Starting with version 2.0, ArcGIS Pro SDK for .NET is exclusively available as vsix installer packages only. If you have previously installed ArcGIS Pro SDK for .NET using the msi mechanism at 1.4 or earlier, uninstall it from the control panel.


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.
  2. On the Tools menu, choose Extensions and Updates.
  3. Search for ArcGIS Pro SDK for .NET:
  • Visual Studio 2015: Expand the Online folder on the left and choose Visual Studio Gallery.
  • Visual Studio 2017: Expand the Online folder on the left and choose Visual Studio Marketplace.

Online_Option1.png

  1. Type ArcGIS Pro SDK in the search box in the upper right corner of the Extensions and Updates dialog box. Among the search results found, the items you'll need are ArcGIS Pro SDK for .NET and ArcGIS Pro SDK for .NET (Utilities) as shown in the following screen shot:

Search1.png

  1. Choose the ArcGIS Pro SDK for .NET package and click the Download button.

  2. The installation experience after this point varies slightly depending on if you are using Visual Studio 2015 or 2017. Follow the appropriate section for the IDE you are working with.

Visual Studio 2017: ArcGIS Pro SDK for .NET will be scheduled for install when Visual Studio 2017 windows are closed. Click Close to dismiss the Extensions and Update dialog and exit Visual Studio.

SDK_Install.png

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

Visual Studio 2015: The Download and Install dialog box for ArcGIS Pro SDK for .NET appears. Click the Install button to complete the installation.

SDK_Install.png

  1. To install ArcGIS Pro SDK for .NET (Utilities) from the Visual Studio Gallery or Marketplace, choose the ArcGIS Pro SDK for .NET (Utilities) package in the Extensions and Update dialog. Click the Download button. Install the ArcGIS Pro SDK for .NET (Utilities) package in the same manner explained above.

  2. Verify that the ArcGIS Pro SDK for .NET templates and utilities are installed in Visual Studio. You should see an ArcGIS folder within the set of New Project templates for Visual C# and Visual Basic. ArcGIS_Pro_Addins_CS1.png

Note: After installation, the Extensions and Updates 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'll 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'll encounter errors when you attempt to create an ArcGIS Pro add-in using the SDK. In Visual Studio enable/disable auto-updates per extension in Tools -> Extensions and Update or at a global level through Tools -> Options

Note: If you have Visual Studio 2015 Update 2+ or Visual Studio 2017 installed, 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.

  2. On the Tools menu, choose Extensions and Updates.

  3. Expand the Updates folder on the left and choose Visual Studio Marketplace (Visual Studio 2017) or Visual Studio Gallery (Visual Studio 2015).

  4. ArcGIS Pro SDK for .NET and ArcGIS Pro SDK for .NET (Utilities) will be listed as packages to update.

  5. Choose ArcGIS Pro SDK for .NET and click the Update button.

  6. Visual Studio 2017: ArcGIS Pro SDK for .NET will be scheduled for update when Visual Studio 2017 windows are closed. Click Close to dismiss the Extensions and Update 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.

    Visual Studio 2015: The Download and Install dialog box for ArcGIS Pro SDK for .NET appears. If you're satisfied with the license agreement, click the Install button to complete the Update installation.

  7. Choose the ArcGIS Pro SDK for .NET (Utilities) package from Visual Studio Marketplace (Visual Studio 2017) or Visual Studio Gallery (Visual Studio 2015). Click the Update button. Update the ArcGIS Pro SDK for .NET (Utilities) package in the same manner.

  8. 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 dialog box in Visual Studio.

new-version-vsix.png

Upgrade from a previous MSI version of ArcGIS Pro SDK for .NET

If you have installed a previous (1.x) version of ArcGIS Pro SDK for .NET using the .msi program, uninstall it from the control panel. Follow the instructions in the Install ArcGIS Pro SDK for .NET section.

Uninstall ArcGIS Pro SDK for .NET

  1. Start Visual Studio.
  2. On the Tools menu, choose Extensions and Updates.
  3. Expand the Installed folder on the left and choose All.
  4. 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


Map Authoring


Map Exploration

    Map Tools


Raster


Sharing


Tasks


Utility Network


Workflow Manager


Reference

    2.0 Migration

Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.