ArcGIS Pro 3.7 API Reference Guide
ArcGIS.Desktop.Core Namespace / CreateProjectSettings Class
Members Example

In This Topic
    CreateProjectSettings Class
    In This Topic
    Provides the settings used to create a new project
    Syntax
    Public Class CreateProjectSettings 
    public class CreateProjectSettings 
    Example
    Create a new project
    {
      //Create a new project using Pro's default settings
      var defaultProjectSettings = Project.GetDefaultProjectSettings();
      var project = Project.CreateAsync(defaultProjectSettings).Result;
    
      // Use project
    }
    Create a new project with specified name
    {
      //Settings used to create a new project
      CreateProjectSettings projectSettings = new()
      {
        //Sets the name of the project that will be created
        // example: projectName =  @"C:\Data\MyProject1\MyProject1.aprx"
        Name = projectName
      };
      //Create the new project
      var project = Project.CreateAsync(projectSettings).Result;
    
      // Use project
    }
    Create new project using Pro's default settings
    {
      //Get Pro's default project settings.
      var defaultProjectSettings = Project.GetDefaultProjectSettings();
      //Create a new project using the default project settings
      var project = Project.CreateAsync(defaultProjectSettings).Result;
    
      // Use project
    }
    New project using a custom template file
    {
      //Settings used to create a new project
      CreateProjectSettings projectSettings = new()
      {
        //Sets the project's name
        Name = projectName,
        //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
      var project = Project.CreateAsync(projectSettings).Result;
    
      // Use project
    }
    Create a project using template available with ArcGIS Pro
    {
      //Settings used to create a new project
      CreateProjectSettings proTemplateSettings = new()
      {
        //Sets the project's name
        Name = projectName,
        //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
      var project = Project.CreateAsync(proTemplateSettings).Result;
    
      // Use project
    }
    Create Project with Template
    {
      var projectFolder = Path.Combine(
          Environment.GetFolderPath(
              Environment.SpecialFolder.MyDocuments),
          @"ArcGIS\Projects");
      CreateProjectSettings ps = new()
      {
        Name = projectName,
        LocationPath = projectFolder,
        TemplatePath = templatePath
      };
      var project = Project.CreateAsync(ps).Result;
      //Use project;
    }
    Inheritance Hierarchy

    System.Object
       ArcGIS.Desktop.Core.CreateProjectSettings

    Requirements

    Target Platforms: Windows 11 Home, Pro, Enterprise (64 bit)

    ArcGIS Pro version: 3.0 or higher.
    See Also