CreateAsync Method—ArcGIS Pro

C#
Visual Basic (Declaration)

public static Task<Project> CreateAsync( 
   CreateProjectSettings createProjectSettings
)

Public Shared Function CreateAsync( _
   Optional ByVal createProjectSettings As CreateProjectSettings _
) As Task(Of Project)

Parameters

createProjectSettings: (optional) The settings that will be use to create a new project. (default value = null)CreateProjectSettings

Return Value

A Task returning the new project that was created

Exception	Description
System.IO.FileNotFoundException	Path { path here } not found.

To create a project with system defaults, please use the CreateProjectSettings.TemplateType property. Use of the system templates via the template path is deprecated as of 2.3.
The default TemplateType is TemplateType.Catalog. Either set a different TemplateType (as needed) or provide a full path to a Pro project template in TemplatePath, in which case the TemplateType is ignored.
If CreateProjectSettings is null, a new untitled project is created (TemplateType.Untitled).

An invalid CreateProjectSettings.TemplatePath will throw a "Path { path here } not found" FileNotFoundException. This includes use of a portal or online Pro project template item URI. The template should be downloaded first.

Create an empty project

C#

//Create an empty project. The project will be created in the default folder
//It will be named MyProject1, MyProject2, or similar...
await Project.CreateAsync();

Create a new project with specified name

C#

//Settings used to create a new project
CreateProjectSettings projectSettings = new CreateProjectSettings()
{
  //Sets the name of the project that will be created
  Name = @"C:\Data\MyProject1\MyProject1.aprx"
};
//Create the new project
await Project.CreateAsync(projectSettings);

Create new project using Pro's default settings

C#

//Get Pro's default project settings.
var defaultProjectSettings = Project.GetDefaultProjectSettings();
//Create a new project using the default project settings
await Project.CreateAsync(defaultProjectSettings);

New project using a custom template file

C#

//Settings used to create a new project
CreateProjectSettings projectSettings = new CreateProjectSettings()
{
  //Sets the project's name
  Name = "New Project",
  //Path where new project will be stored in
  LocationPath = @"C:\Data\NewProject",
  //Sets the project template that will be used to create the new project
  TemplatePath = @"C:\Data\MyProject1\CustomTemplate.aptx"
};
//Create the new project
await Project.CreateAsync(projectSettings);

Create a project using template available with ArcGIS Pro

C#

//Settings used to create a new project
CreateProjectSettings proTemplateSettings = new CreateProjectSettings()
{
  //Sets the project's name
  Name = "New Project",
  //Path where new project will be stored in
  LocationPath = @"C:\Data\NewProject",
  //Select which Pro template you like to use
  TemplateType = TemplateType.Catalog
  //TemplateType = TemplateType.LocalScene
  //TemplateType = TemplateType.GlobalScene
  //TemplateType = TemplateType.Map
};
//Create the new project
await Project.CreateAsync(proTemplateSettings);

Create Project with Template

C#

var projectFolder = System.IO.Path.Combine(
    System.Environment.GetFolderPath(
        Environment.SpecialFolder.MyDocuments),
    @"ArcGIS\Projects");

CreateProjectSettings ps = new CreateProjectSettings()
{
  Name = "MyProject",
  LocationPath = projectFolder,
  TemplatePath = @"C:\data\my_templates\custom_template.aptx"
};

var project = await Project.CreateAsync(ps);

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3 or higher.

Reference

Project Class
Project Members