Skip to content

Releases: Esri/arcgis-pro-sdk

ArcGIS Pro 1.1 SDK for .NET (Beta)

22 Apr 14:24
Compare
Choose a tag to compare
Pre-release

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.

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

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.

1. Config.daml not Updated by New Item Template

  • You have edited your Config.daml file by hand in Visual Studio
  • You have not saved your changes
  • Config.daml is the active tab in Visual Studio
  • You run one of the ArcGIS Pro SDK item templates (eg to add a new Button or Dockpane)
  • The Config.daml file in Visual Studio does not appear to be updated.

Workaround

  • Close the Config.daml file tab in Visual Studio.
  • Re-open it from the Visual Studio solution explorer
  • *If it still doesn't show the update, locate the Config.daml file on disk and copy and paste the contents of the file on disk into the Visual Studio Config.daml editing window.
  • Save your edits

2. Install Issue if Locale is other Than English

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

3. API Reference guide TOC Display issues on some desktops

  • When you browse to the API Reference guide on some desktop machines, you will see the TOC like this image below:
    TOC-issue.png
  • The TOC layout has adapted to a touch device. In that mode, the TOC, search, Index etc. are available from the icons on the toolbar at the top of the page. We have noticed this mainly on the Chrome browser which sometimes identifies a device as touch capable if you have a touchscreen laptop or are running on a Virtual Machine.

4. Add-in is not loaded by Pro when you "build" it in Visual Studio

  • You have deleted the add-in file (*.esriAddinX file) from the C:\Users\<UserName>\Documents\ArcGIS\AddIns\ArcGISPro folder.
  • Without making any code changes, you "Build" the add-in project in Visual Studio and launch ArcGIS Pro or click the "Start" button in Visual Studio to launch the debugger.
  • Your add-in does not load in ArcGIS Pro.

Workaround

  • From Visual Studio's Build menu, click the Rebuild Solution menu item. This will create the add-in file (*.esriAddinX file) under C:\Users\<UserName>\Documents\ArcGIS\AddIns\ArcGISPro folder. When you launch ArcGIS Pro, your add-in will now load.

5. Controls do not Work in ArcGIS Pro after the Add-in Project's Namespace and/or Assembly is Changed

  • You changed one or more of the following:
    • You changed the Assembly name and/or Default namespace in your project Application properties within Visual Studio
    • You changed the namespace in your add-in Module and/or add-in class files.

When ArcGIS Pro loads your add-in, one or more of the controls defined in your add-in do not work. For example, a new button in your add-in is unresponsive when you click it and becomes permanently disabled.

Fix
One or more of the following conditions may need to be fixed:

  • The defaultAssembly and defaultNamespace attributes on the root ArcGIS daml element within your Config.daml must be changed to match any changes you made to the corresponding Visual Studio project Application properties.
<?xml version="1.0" encoding="utf-8"?>
<ArcGIS defaultAssembly="MyRenamedAssembly.dll" defaultNamespace="MyRenamedAssembly" xmlns="..." xmlns:xsi="..." xsi:schemaLocation="...">
  <AddInInfo id="...
....
  • If the namespace of an add-in class (in the code file) does not match the defaultNamespace attribute of the <ArcGIS> element in the Config.daml, you must fully qualify the className attribute of its daml element (with "namespace.classname") in Config.daml.

For example: Assume this is the class file of a button. Note the namespace.

namespace MyRenamedAssembly.Addins {
     class Button1 : Button
    {
        protected override void OnClick() {

Assume this is the Config.daml. Note the <ArcGIS defaultNamespace

<!-- the defaultNamespace is MyRenamedAssembly -->
<ArcGIS defaultAssembly="MyRenamedAssembly.dll" defaultNamespace="MyRenamedAssembly" xmlns="...

    <!-- the button className attribute is fully qualified -->
   <button .... className="MyRenamedAssembly.Addins.Button1" ... />
  • Rebuild the add-in project