ArcGIS Pro 3.1 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 with specified name
    //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
    //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
    //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
    //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
    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);
    Inheritance Hierarchy

    System.Object
       ArcGIS.Desktop.Core.CreateProjectSettings

    Requirements

    Target Platforms: Windows 11, Windows 10

    ArcGIS Pro version: 3.0 or higher.
    See Also