ArcGIS Explorer SDK

Feedback E-mail this topic Print this topic

Introduction

ArcGIS Explorer includes a Software Developer Kit (SDK). The aim of the SDK is to support developers in using the ArcGIS Explorer Application Programming Interface (API) to build add-ins which plug into the ArcGIS Explorer application.

An add-in can be used to add a wide variety of functions to the standard ArcGIS Explorer interface, as it can execute any custom code. You could use an add-in to retrieve data or images from the Internet, query a remote database, perform a geoprocessing task on a remote server and extract information from the results, and so on.

You can also use an add-in in order to interact with the other classes in the object model of ArcGIS Explorer; for example you can find out information about the existing layers and results, run other add-ins, add content to the map and search the features in local vector layers.

ArcGIS Explorer API provides six types of 'Add-Ins' as a means to extend the application: buttons, check boxes, combo boxes, dockable windows, extensions, and galleries. Each type of add-in is implemented in .NET by deriving from an abstract class in the ESRI.ArcGISExplorer.Application namespace.

The ArcGIS Explorer API and the Microsoft .NET 3.5 SP1 Framework

The ArcGIS Explorer API relies upon the Microsoft .NET 3.5 Framework Service Pack 1. The .NET Framework is integral to successful development and deployment of add-ins; either Microsoft Visual Studio 2008 or 2010 (.NET development environments) is required to develop add-ins. The .NET Framework is an install requirement for ArcGIS Explorer, and so is present on machines to which add-ins are deployed. The ArcGIS Explorer API supports all current editions of Microsoft Visual Studio 2008 and 2010 (Express through to Enterprise), and two .NET languages (C# and VB.NET) are supported for add-in development.

Using Microsoft Visual Studio and the ArcGIS Explorer API, add-ins can be developed. Once you have authored an add-in in Visual Studio, the add-in is compiled as a Dynamic Link Library (DLL) file and packaged into an Add-in file (.eaz). When you point ArcGIS Explorer at the add-in file, it recognizes the file as an add-in, and the add-in is available for use in ArcGIS Explorer using the ArcGIS Explorer Add-Ins dialog.

Note  Add-ins are the only type of programmatic customization possible in ArcGIS Explorer; you cannot create any other types of custom class for ArcGIS Explorer, neither can you embed ArcGIS Explorer functionality into any other application. Non-programmatic customization of the appearance of the application is possible using application configuration files.
Learn more about application configurations

About the ArcGIS Explorer Software Developer Kit

To create an add-in, you must install the ArcGIS Explorer SDK. In addition to a version of its conceptual and component help that integrates into the Visual Studio IDE, the ArcGIS Explorer SDK installs a number of items that empower developers to make the most of the ArcGIS Explorer API:

• Class Diagrams of ArcGIS Explorer API classes (the ESRI.ArcGISExplorer namespace)

The class diagrams show you how the various classes are exposed by the ArcGIS Explorer API. You can use the diagram as a handy shortcut to finding the class you want to work with. The diagram also helps you understanding how the classes fit together to form the API.


• Project and Item Templates for Visual Studio

The ArcGIS Explorer SDK installs a number of project templates which help you to create a new add-in easily. Different add-in templates are available to create each of the types of add-ins.


• Sample add-in projects

A number of sample add-ins have already been authored and installed with the ArcGIS Explorer SDK. By compiling the add-ins and stepping through the code (as the sample executes) you can gain a further understanding of the API. The add-in samples may already provide some of the functionality you intend to develop, so it may be a time saving exercise to check the samples before starting development of an add-in.


• Snippets

Code snippets are reusable, add-in-oriented blocks of code. The ArcGIS Explorer SDK installs numerous code snippets, which are accessed via an IntelliSense context menu in Visual Studio. When you have mastered the ArcGIS Explorer API, you may wish to complement the code snippets installed by the ArcGIS Explorer SDK with your own code snippets to increase your own development efficiency.

ArcGIS Online has information on ArcGIS Server and publishing layers viewable in ArcGIS Explorer; for more information on creating add-ins, consult the ArcGIS Explorer Developer Help.