Creating an add-in project
Creating an add-in project
The first step to creating any add-in is the creation of an add-in project. This topic guides you through the step-by-step process of creating a new add-in project using the Python Add-In Wizard.
You must make sure that you have the Python Add-In Wizard installed. If you have not downloaded it, click here to download. These instructions define an add-in project for ArcMap. There are no differences in creating an add-in project for any of the supported ArcGIS for Desktop software products.
Creating a Python add-in project consists of two steps:
-
Choose an add-in project folder.
Locate the addin_assistant.exe file in the location where you installed the Python Add-In Wizard and double-click. The Browse For Folder dialog box will open where you are required to enter a folder to store your add-in project. You must choose an empty folder or make a new folder. Click OK.
- Enter the project settings.
Once a working folder is selected, the first panel of the wizard is displayed. This is where you enter the project settings. These settings are the project's metadata and stored in the config.xml file. They become important at deployment time when the add-in is being used.
The following is a description of each setting found on the Project Settings tab:
Setting | Description |
|---|---|
Working Folder(required) | The folder selected to host the necessary add-in files and folders. |
Product(required) | The ArcGIS for Desktop product that hosts the add-in. The options are ArcCatalog, ArcMap, ArcGlobe, and ArcScene. |
Name(required) | The name of the project. This should be a descriptive name that encompasses all the add-in contents that will be developed for this project. |
Version(required) | The version of the project is used to determine the deployment release number of the add-in. By default, a value of 0.1 is used. It is possible to increase versions in decimal point increments (for example, 0.2, 0.3, 1.0, 1.1, and so on). |
Company(optional) | The name of your organization. |
Description(optional) | A brief description of the purpose for your project. This should be a description that encompasses all of the add-in contents that will be developed for this project. |
Author(optional) | The name of the person who created the project. |
Image(optional) | If you would like to incorporate an image for your project, you can select one. The image will be copied to a folder named Images, which is created when you save the project. This folder is located inside your working folder. |
The properties name, company, version, description, and image are all used after your add-in project is deployed (see Sharing add-ins for steps on this process). The following illustrates an example of how this metadata is used in the Add-In Manager after your project is deployed. The Add-In Manager is located in the desktop application under the Customize menu.
Once the project settings are entered, click the Save button on the bottom of the wizard. Do not close the wizard. The following steps include creating your add-in customizations. Click the Add-In Contents tab and proceed to one of the following topics for information and steps to create an add-in: