ProGuide Installation and Upgrade - Esri/arcgis-pro-sdk GitHub Wiki

Language:      C#
Subject:       Framework
Contributor:   ArcGIS Pro SDK Team <[email protected]>
Organization:  Esri, http://www.esri.com
Date:          10/06/2024
ArcGIS Pro:    3.4
Visual Studio: 2022

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

• Install ArcGIS Pro SDK for .NET
  • Upgrade to .NET 8.0
  • Migrating from 2.x
• Upgrade ArcGIS Pro SDK for .NET
• Uninstall ArcGIS Pro SDK for .NET
• Distribute ArcGIS Pro SDK for .NET using a private gallery

ArcGIS Pro SDK for .NET provides the following 3 Visual Studio extensions (.vsix files):

• ArcGIS Pro SDK for .NET: A collection of project and item templates to create ArcGIS Pro Add-ins.
• ArcGIS Pro SDK for .NET (Utilities): A collection of utilities to help create ArcGIS Pro Add-ins.
• ArcGIS Pro SDK for .NET (Migration): Migrates ArcGIS Pro SDK 2.x extensions to ArcGIS Pro SDK 3.0 for .Net

You do not need administrative access or elevated user permissions to install ArcGIS Pro SDK for .NET.

Pro SDK for .NET extensions can be integrated into Visual Studio 2022 v17.8 or higher only. ArcGIS Pro 3.3 (and higher versions) SDK requires .NET 8 or better. Refer to the Requirements section of the wiki for a detailed list of requirements to work with the SDK.

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

1. Start Visual Studio.
2. On the Extensions menu, choose Manage Extensions. This will bring up the Manage Extensions dialog.
3. Confirm that the "Browse Location" is set to Visual Studio Marketplace.
   
4. Type ArcGIS Pro SDK in the search box. Among the search results found, the items you will need are ArcGIS Pro SDK for .NET, ArcGIS Pro SDK for .NET (Utilities) and ArcGIS Pro SDK for .NET (Migration) as shown in the following screen shot:
   
5. Choose the ArcGIS Pro SDK for .NET package and click the Install button. Optionally, choose ArcGIS Pro SDK for .NET (Utilities) and ArcGIS Pro SDK for .NET (Migration) and click the Install button for each of these extensions. This will allow you to download and install all three extensions in one step.
6. ArcGIS Pro SDK for .NET will be scheduled for install when Visual Studio windows are closed.
7. 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.
   
8. Verify that the ArcGIS Pro SDK for .NET templates and utilities are installed in Visual Studio.
   • Access the Create New Project option from the Visual Studio start window.
     
     Filter all the available Project templates by using custom ArcGIS Pro SDK Project Type Filter. You should see ArcGIS Pro SDK templates. Note: After installation, the Manage Extensions 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.

Starting at release 3.3, ArcGIS Pro moved to .NET 8, Microsoft's latest version of .NET (formerly known as ".NET Core") with Long Term Support, LTS. This is not a breaking change but will require an update of Visual Studio 2022 to version 17.8+ and .NET 6 to .NET 8. Consult the https://github.com/Esri/arcgis-pro-sdk/wiki/ProGuide .NET 8 Upgrade for more information.

If you have an addin created using version 2.x and the .NET Framework, follow the procedure in the https://github.com/Esri/arcgis-pro-sdk/wiki/ProConcepts 3.0 Migration Guide to convert your project to Pro 3.0+ and .NET 6+ (from .NET Framework) first and then follow the procedure in the https://github.com/Esri/arcgis-pro-sdk/wiki/ProGuide .NET 8 Upgrade, as necessary, to re-compile on Pro 3.3+ and .NET 8.

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.

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 Extension -> Manage Extensions. Enable/disable auto-updates at a global level through Tools -> Options.

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 Extensions menu, choose Manage Extensions. This will bring up the Manage Extensions dialog.
3. Click the Updates tab on the top.
4. 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.
5. Choose ArcGIS Pro SDK for .NET and click the Update button.
6. 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.
7. Choose the ArcGIS Pro SDK for .NET (Utilities) package from Visual Studio Marketplace. Click the Update tab. 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 Manage Extensions dialog box in Visual Studio.
   

1. Start Visual Studio. On the Extensions menu, choose Manage Extensions. This will bring up the Manage Extensions dialog.
2. Click the Installed tab at the top.
3. Find the ArcGIS Pro SDK for .NET, ArcGIS Pro SDK for .NET (Migration) and ArcGIS Pro SDK for .NET (Utilities) packages and click the ellipsis button and select Uninstall.
   

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.