Extend ArcGIS Pro with ArcGIS Pro SDK for .NET. ArcGIS Pro SDK for .NET is based on the add-in and configurations extensibility pattern. Leverage modern .NET features and patterns such as Task Asynchronous Programming (TAP), LINQ, WPF Binding, and MVVM to write integrated 2D/3D add-ins using Pro’s new APIs.
- Requirements
- Installing ArcGIS Pro SDK for .NET
- ArcGIS Pro SDK for .NET components
- Getting started
- ProGuide: ArcGIS Pro Extensions NuGet
- ProConcepts: Migrating to ArcGIS Pro
- ProSnippets
- ArcGIS Pro API
- Release notes
- Previous versions
- Resources
- ProSnippets: Framework
- ProConcepts: Framework
- ProConcepts: Advanced topics
- ProGuide: Command line switches for ArcGISPro.exe
- ProGuide: Reusing ArcGIS Pro Commands
- ProGuide: Licensing
- ProGuide: Digital signatures
Add-ins
- Pro Guide: Installation
- Pro Guide: Your first add-in
- ProConcept: Localization
- ProGuide: Content and image resources
- ProGuide: Diagnosing ArcGIS Pro Add-ins
Configurations
Customization
- ProGuide: Ribbon, tabs, and groups
- ProGuide: Buttons
- ProGuide: Label controls
- ProGuide: Check boxes
- ProGuide: Edit boxes
- ProGuide: Combo boxes
- ProGuide: Palettes and Split buttons
- ProGuide: Galleries
- ProGuide: Dockpanes
- ProGuide: Code your own states and conditions
Styling
- ProSnippets: Editing
- ProConcepts: Editing
- ProConcepts: Annotation Editing
- ProConcepts: Dimension Editing
- ProGuide: Editing Tool
- ProGuide: Construction Tools with Options
- ProGuide: Annotation Construction Tools
- ProGuide: Annotation Editing Tools
- ProGuide: Templates
- ProSnippets: Geodatabase
- ProConcepts: Geodatabase
- ProConcepts: Plugin Datasources
- ProGuide: Plugin Datasources
Relational Operations
Reports
- ProSnippets: Map Authoring
- ProSnippets: Annotation
- ProSnippets: Labeling
- ProSnippets: Renderers
- ProSnippets: Symbology
- ProSnippets: Text Symbols
- ProConcepts: Map Authoring
- ProConcepts: Annotation
- ProConcepts: Dimensions
- ProGuide: Geocoding
Scene
Stream
- ProSnippets: Map Exploration
- ProSnippets: Custom Pane with Contents
- ProConcept: Map Exploration
- ProGuide: Map Pane Impersonation
- ProGuide: TableControl
Map Tools
- ProGuide: Feature Selection
- ProGuide: Identify
- ProGuide: MapView Interaction
- ProGuide: Embeddable Controls
- ProGuide: Custom Popups
- ProGuide: Dynamic Popup Menu
- API Reference online
- ArcGIS Pro SDK for .NET (pro.arcgis.com)
- arcgis-pro-sdk-community-samples
- ArcGISPro Registry Keys
- FAQ
- ArcGIS Pro SDK icons
The requirements for the machine on which you develop your ArcGIS Pro add-ins are listed here.
- ArcGIS Pro 2.4
- Windows 10 (Home, Pro, Enterprise) (64 bit)
- Windows 8.1 (Pro, and Enterprise) (64 bit)
- Windows 7 SP1 (Ultimate, Professional and Enterprise) (64 bit)
- Microsoft .NET Framework 4.6.1 Developer Pack
- Visual Studio 2019 (Professional, Enterprise, and Community Editions)
- Visual Studio 2017 (Professional, Enterprise, and Community Editions)
Deprecation notice: Visual Studio 2015 has been deprecated at 2.3. ArcGIS Pro SDK 2.4 works with Visual Studio 2017 and 2019.
Note: ArcGIS Pro system requirements
ArcGIS Pro SDK for .NET can be downloaded and installed using either one of the following options:
- Download and install from within Visual Studio
- Download from MyEsri.com
Read the ProGuide: Installation and Upgrade for detailed installation instructions.
The following table summarizes the functionality of each .vsix file included in the SDK download:
| Name | File | Functionality |
|---|---|---|
| ArcGIS Pro SDK for .NET | proapp-sdk-templates.vsix | A collection of project and item templates to create ArcGIS Pro add-ins |
| ArcGIS Pro SDK for .NET (Utilities) | proapp-sdk-utilities.vsix | A collection of utilities to help create ArcGIS Pro add-ins |
Package: proapp-sdk-templates.vsix
ArcGIS Pro SDK for .NET provides the following project and item templates:
| C# | VB | Name |
|---|---|---|
 |
 |
ArcGIS Pro Module Add-in Project template |
 |
 |
ArcGIS Pro Managed Configurations Project template |
 |
N/A | ArcGIS Pro Plugin Project template |
 |
N/A | ArcGIS Pro CoreHost Application Project template |
 |
 |
ArcGIS Pro Backstage Tab |
 |
 |
ArcGIS Pro Button |
 |
 |
ArcGIS Pro Button Palette |
 |
 |
ArcGIS Pro Combo Box |
 |
 |
ArcGIS Pro Construction Tool |
 |
 |
ArcGIS Pro Custom Control |
|
N/A | ArcGIS Pro Custom Item |
|
N/A | ArcGIS Pro Custom Project Item |
 |
 |
ArcGIS Pro Dockpane |
|
|
ArcGIS Pro Dockpane with Burger Button |
 |
 |
ArcGIS Pro Drop Handler |
 |
 |
ArcGIS Pro Embeddable Control |
 |
 |
ArcGIS Pro Gallery |
 |
 |
ArcGIS Pro Inline-Gallery |
 |
 |
ArcGIS Pro Map Pane Impersonation |
 |
 |
ArcGIS Pro Map Tool |
 |
 |
ArcGIS Pro Menu |
 |
 |
ArcGIS Pro Pane |
 |
 |
ArcGIS Pro Property Sheet |
 |
 |
ArcGIS Pro Split Button |
Package: proapp-sdk-utilities.vsix
ArcGIS Pro SDK for .NET (Utilities) provides the following utilities that extend the Visual Studio environment:
| Name | Description |
|---|---|
| Pro Fix References utility | Fixes broken references in an ArcGIS Pro add-in. Broken references can be caused when you share add-ins with other colleagues or download add-ins where the ArcGIS Pro assembly references point to a different location from where you installed them. |
| Pro Generate DAML Ids utility | Converts all of the ArcGIS Pro Desktop Application Markup Language (DAML) string IDs into static string properties organized by DAML element types (for example, Button, Dockpane, Tool, Condition, and so on). This allows you to use the IntelliSense feature of Visual Studio within your source code file to add IDs, rather than having to manually type DAML string IDs). |
See ProGuide: Build your first add-in for step-by-step instructions on creating a basic button that appears on the ArcGIS Pro ribbon.
ProSnippets are ready-made snippets of code you can quickly insert into your ArcGIS Pro add-in. List of available ProSnippets.
The ArcGIS Pro APIs are managed .NET assemblies. Intermediary assemblies containing .NET metadata or PIAs (Primary Interop Assemblies) are not required.
Add any of the ArcGIS Pro managed assemblies that comprise its API as references directly in your Visual Studio add-in projects
A complete list of the ArcGIS Pro assemblies in the public API is provided below:
Core assemblies are located in the {ArcGIS Pro Installation folder}\bin.
| Assembly | Description |
|---|---|
| ArcGIS.Core.dll | Provides CIM, Geodatabase, Geometry and Utility Network APIs. |
| ArcGIS.CoreHost.dll | Provides Host.Initialize to initialize ArcGIS.Core.dll for stand-alone use. |
| ArcGIS.Desktop.Framework.dll | Provides the application framework to include add-in contracts, DAML support, and base classes. This assembly must be referenced by every add-in. |
| ESRI.ArcGIS.ItemIndex.dll | Provides functionality to create and work with Custom items. |
Major subsystems within ArcGIS Pro are organized into units called extensions. Extension assemblies are located in the {ArcGIS Pro Installation folder}\bin\Extensions folder in their own individual subfolder. Extension subfolder names are logically named for the unit of functionality they represent, for example, Mapping, Editing, Layout, and so on.
| Assembly | Description |
|---|---|
| ArcGIS.Desktop.Catalog.dll | Provides access to project content items (map items, layout items, style items, folder items, and so on). |
| ArcGIS.Desktop.Core.dll | Provides functionality to create and manage projects, access to events associated with the current project, and the ability to execute geoprocessing tools. |
| ArcGIS.Desktop.DataReviewer.dll | Provides functionality to establish and manage Reviewer results, sessions, and batch jobs in a project. |
| ArcGIS.Desktop.Editing.dll | Provides access to the editing environment and core editing functionality required for custom edit tool implementations. |
| ArcGIS.Desktop.Extensions.dll | Provides extension methods for other ArcGIS Pro classes. Provides a base class for custom map tools. |
| ArcGIS.Desktop.Geoprocessing.dll | Provides access to geoprocessing history items stored in the project. (Note: Adds a reference to ArcGIS.Desktop.Core.dll to execute geoprocessing tools.) |
| ArcGIS.Desktop.Layouts.dll | Provides functionality for manipulating elements on a layout and exporting to a variety of image formats. |
| ArcGIS.Desktop.Mapping.dll | Provides types to create maps and layers, label features, perform query operations, and visualize them in 2D or 3D. Provides a raster API to create raster layers and customize raster rendering, and an API to manage styles, style items, and symbols. |
| ArcGIS.Desktop.TaskAssistant.dll | Provides the Tasks framework, allowing developers to access, open, close, or export task items. |
| ArcGIS.Desktop.Workflow.dll | Provides functionality to create, configure, and execute Workflow Manager jobs and queries. Provides functionality to retrieve configuration information from the Workflow Manager database. |
There are extension assemblies in {ArcGIS Pro Installation folder}\bin\Extensions subfolders) that do not have a public API. They are currently for Esri internal use only.
- ArcGIS.Desktop.Analyst3D.dll
- ArcGIS.Desktop.Aviation.dll
- ArcGIS.Desktop.BusinessAnalyst.dll
- ArcGIS.Desktop.Charts.dll
- ArcGIS.Desktop.DataSourcesRaster.dll
- ArcGIS.Desktop.DefenseMapping.dll
- ArcGIS.Desktop.Editing.PushPull.dll
- ArcGIS.Desktop.FullMotionVideo.dll
- ArcGIS.Desktop.GAWizard.dll
- ArcGIS.Desktop.Geostatistics.dll
- ArcGIS.Desktop.LocationReferencing.dll
- ArcGIS.Desktop.Metadata.dll
- ArcGIS.Desktop.NetworkAnalysis.Facility.dll
- ArcGIS.Desktop.NetworkAnalysis.NetworkDiagrams.dll
- ArcGIS.Desktop.NetworkAnalysis.Transportation.dll
- ArcGIS.Desktop.Search.dll
- ArcGIS.Desktop.Sharing.dll
- ArcGIS.Desktop.TerritoryDesign.dll
Note: Static string resource properties and image resources included within the public API assemblies are for Esri internal use only. They are not intended for use in third-party add-ins.
These release notes describe details of the ArcGIS Pro 2.4 SDK for .NET release. Here you will find information about available functionality as well as known issues and limitations.
The following functionality is available at the ArcGIS Pro 2.4 SDK for .NET release:
This Visual Studio project template is used to create ArcGIS Pro CoreHost Applications.
This Visual Studio item template is used to create a custom item in your Add-in and Configurations.
This Visual Studio item template is used to create a custom project item in your Add-in and Configurations.
Visual Studio 2019:
- New support for Visual Studio 2019, with continued support for Visual Studio 2017.
Enhanced Scene Layer API:
- Enhancements to work with filters and filter blocks, queries, selections, and symbology.
New Stream Layer API:
- Manage real-time data, streaming, selection, filters, tracking and events.
Map Authoring API Updates:
- Layer creation enhancements, symbol lookup, JSON support for the CIM.
Geometry API Updates:
- Access to multipatch feature properties.
Vector Tiles Styling:
- Support for manipulating vector tile styles.
Custom Items:
- Catalog support for custom items.
Report API:
- Enhancements to work with reports.
ArcGIS Pro Extensions NuGet:
- Full support availability.
For a detailed list of changes to the ArcGIS Pro API refer to the What's new for developers at 2.4 topic in the ArcGIS Pro API Reference Guide.
There are many ProConcepts, ProGuide, ProSnippets, and samples to help you get up and running with the new SDK features including:
Updates to the SDK Resources include, but not limited to:
- ProConcepts: Framework
- ProConcepts: Map Authoring
- ProConcepts: Layouts
- ProConcepts: Scene Layers
- ProConcepts: Stream Layers
- ProConcepts: Custom Items
- ProGuide: Custom Items
- The Pro Community Samples and Snippets have new samples and snippets.
- The API Changes section of the What’s New for Developers 2.4 page.
- ArcGIS Pro 2.3 SDK for .NET
- ArcGIS Pro 2.2 SDK for .NET
- ArcGIS Pro 2.1 SDK for .NET
- ArcGIS Pro 2.0 SDK for .NET
- ArcGIS Pro 1.4 SDK for .NET
- ArcGIS Pro 1.3 SDK for .NET
- ArcGIS Pro 1.2 SDK for .NET
- ArcGIS Pro 1.1 SDK for .NET
Esri welcomes contributions from anyone and everyone. For more information, see our guidelines for contributing.
Find a bug or want to request a new feature? Let us know by submitting an issue.
Copyright 2019 Esri
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at:
http://www.apache.org/licenses/LICENSE-2.0.
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
A copy of the license is available in the repository's license.txt file.
Home | API Reference | Requirements | Download | Samples