Visual Studio integration

This topic describes how ArcGIS Enterprise SDK is integrated with Microsoft Visual Studio.

Getting started with the ArcGIS extension project templates

To enhance the developer experience, ArcGIS Enterprise SDK installation adds custom ArcGIS extension templates to the Visual Studio integrated developer environment (IDE). ArcGIS Enterprise SDK supports the following versions of Microsoft Visual Studio:

  • Microsoft Visual Studio 2017 (C#, VB.NET) Community, Professional, Enterprise
  • Microsoft Visual Studio 2019 (C#, VB.NET) Community, Professional, Enterprise

The Visual Studio IDE Integration Framework is an optional feature included with the SDK.

Once you have installed the ArcGIS Enterprise SDK with the Visual Studio IDE Integration Framework feature, you can create new projects for development of extensions and interceptors by using one of the ArcGIS Enterprise SDK templates available in the New Project dialog box of Visual Studio. A project template includes all the necessary boilerplate code to begin a specific type of extensions development.

For general information on creating and using solutions and projects in Visual Studio, see the documentation on the Microsoft Visual Studio Web site. You can also find step-by-step information on using the different elements of the ArcGIS Visual Studio Integration Framework in the .NET development walkthroughs.

Opening the New Project dialog box

To open the New Project dialog box, select the following:

  • In Visual Studio:Click File, click New, then click Project.

    -or-

    Click Add, then click New Project (if an existing project is open).

To access the ArcGIS new project templates, click the Visual Basic or Visual C# node in the Project types pane, click ArcGIS, then click Server Object Extensions. See the following screenshot:

ac49a4d3 c1e1 411c a3fb c0e2b11f24fc1

When you first start Visual Studio, you are prompted to choose a development setting; choosing different settings changes the options displayed in Visual Studio in various places. If you cannot find the project templates as previously described, locate and expand the Other Languages node in the Project types pane.

Once you have made the selection in the Project types pane, a list of the available templates is displayed in the Templates pane. Each project template creates the code files and the references and property settings appropriate for the selected project type. When you select a template, a brief description of that item appears beneath the Project types pane.

When you have selected a project template and set the appropriate name and location for your new project, click OK.

Available ArcGIS project templates for Visual Studio 2019

  • For C#
    • REST SOE Template (ArcGIS Pro)
    • SOAP SOE Template (ArcGIS Pro)
    • CSharp SOI Template (ArcGIS Pro)
  • For Visual Basic
    • REST SOE Template (VB) (ArcGIS Pro)
    • SOAP SOE Template (VB) (ArcGIS Pro)
    • VB SOI Template (ArcGIS Pro)

Available ArcGIS project templates for Visual Studio 2017

The following are available project templates (for visual C#) for ArcGIS Enterprise SDK:

  • ArcGIS -> Server Object Extensions
    • REST SOE Template (ArcGIS Pro)
    • SOAP SOE Template (ArcGIS Pro)
  • ArcGIS -> Server Object Interceptors
    • C# SOI Template (ArcGIS Pro)

If you have installed the ArcObjects SDK for .NET along with the ArcGIS Enterprise SDK on the same machine, the available project templates (for Visual C#) are as follows:

  • ArcGIS -> Server Object Extensions
    • REST SOE Template (ArcGIS Pro)
    • REST SOE Template (ArcMap)
    • SOAP SOE Template (ArcGIS Pro)
    • SOAP SOE Template (ArcMap)
  • ArcGIS -> Server Object Interceptors
    • C# SOI Template (ArcGIS Pro)
    • C# SOI Template (ArcMap)

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.