Skip to content

ArcGIS Pro 1.1 SDK for .NET (Beta)

Uma Harano edited this page Apr 20, 2015 · 1 revision

ArcGIS Pro 1.1 SDK for .NET (Beta)

Extend ArcGIS Pro with the ArcGIS Pro SDK for .NET, available at the 1.1 Beta release. ArcGIS Pro SDK for .NET is based on the add-in extensibility pattern (first introduced at 10.1). 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.


In this topic

##Requirements The requirements for the machine on which you develop your ArcGIS Pro add-ins are listed here.

####Supported platforms

  • Windows 8.1 Basic, Professional, and Enterprise (64 bit [EM64T])
  • Windows 8 Basic, Professional, and Enterprise (64 bit [EM64T])
  • Windows 7 SP1 Ultimate, Enterprise, Professional, and Home Premium (64 bit [EM64T])

####Supported .NET framework

  • 4.5.2
  • 4.5.1
  • 4.5

####Supported IDEs

  • Visual Studio 2013 (Professional, Premium, Ultimate, and Community Editions)

##Download

Download the ArcGIS Pro SDK from the ArcGIS Pro Beta Community.

##Installing ArcGIS Pro SDK

Unzip the ArcGIS Pro SDK for .NET download from the Beta Community site. Double-click each of the Microsoft Visual Studio VSIX packages to start the installation process. You do not need administrative access or elevated user permissions.

The table below summarizes the functionality of each .vsix file included in the SDK download:

Name File Name What it does
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

####ArcGIS Pro SDK (templates) Package: proapp-sdk-templates.vsix

The ArcGIS Pro SDK for .NET provides the following project and item templates:

C# VB Name
ArcGIS Pro Module Add-in
ArcGIS Pro Button
ArcGIS Pro Button Palette
ArcGIS Pro Combo Box
ArcGIS Pro Construction Tool
ArcGIS Pro Dockpane
ArcGIS Pro Dockpane with Burger Button
ArcGIS Pro Drop Handler
ArcGIS Pro Gallery
ArcGIS Pro Inline-Gallery
ArcGIS Pro Map Tool
ArcGIS Pro Menu
ArcGIS Pro Pane
ArcGIS Pro Sketch Tool
ArcGIS Pro Split Button
ArcGIS Pro Tool

####ArcGIS Pro SDK (utilities) Package: proapp-sdk-utilities.vsix

The ArcGIS Pro SDK for .NET (utilities) provides the following utilities that extend the Visual Studio environment:

pro-fix-references

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 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).

Getting started

Refer to the ProGuide: Build your first add-in for step-by-step instructions on creating a basic button that appears on the ArcGIS Pro ribbon.

##ArcGIS Pro API The ArcGIS Pro APIs are written exclusively in C#, unlike ArcObject assemblies, which are written as COM DLLs. Because ArcGIS Pro assemblies 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.

pro-references.png

A complete list of the ArcGIS Pro assemblies is provided below:

###Core

Core assemblies are located within the {ArcGIS Pro Installation folder}\bin.

Assembly Description
ArcGIS.Core.dll Provides CIM, Geodatabase, and Geometry APIs.
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.

###Extensions

Major subsystems within ArcGIS Pro are organized into units called extensions. Extension assemblies are located within 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.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 and editing layout elements, resourcing pictures on layouts, and export of layouts to various 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.

Extensions with no public API

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.Analys3D.dll
  • ArcGIS.Desktop.DataReviewer.dll
  • ArcGIS.Desktop.DataSourcesRaster.dll
  • ArcGIS.Desktop.Geostatics.dll
  • ArcGIS.Desktop.NetworkAnalysis.Transportation.dll
  • ArcGIS.Desktop.Search.dll
  • ArcGIS.Desktop.Sharing.dll

##Release Notes

###ArcGIS Pro 1.1 SDK Beta

These release notes describe details of the ArcGIS Pro 1.1 SDK for .NET beta release. Here you will find information about functionality available in the release and known issues and limitations.

####New functionality

Since this is the first release of ArcGIS Pro 1.1 SDK, there is technically no new functionality to describe.

####Known Issues

The following are known issues or limitations with the ArcGIS Pro 1.1 SDK Beta release. Where one is available, a workaround is described.

  • If an ArcGIS Pro add-in's config.daml file has edits and you add a new item template, the changes from the template are not shown in the daml. Close the config.daml and reopen it to see the new item template you added.
  • ArcGIS Pro SDK templates and utilities cannot be installed if your locale is not English. Change your locale to English and then run the vsix packages.

##Resources

Clone this wiki locally