Creating, Reading and Saving Projects

Aspose.Tasks for .NET lets you work with Microsoft Project (MPP/XML) files without having Microsoft Project installed, or using Microsoft Office Automation. A powerful and flexible API, Aspose.Tasks saves you time and effort by giving you the tools you need to write efficient code for manipulating project files.

Aspose.Tasks can open existing files, but it can also create new files. This article explains how to create a new and empty project file from the stream using the Project class. as well as open existing files.

Creating an Empty Project File

The Project class is the main class in Aspose.Tasks used to set and get properties associated with a project, as well as behavior. The Save method offered by this class makes it possible to render the Project to various output formats such as XML, MPP, PDF, HTML, etc. with a single API call. This method accepts a file stream or file name, and one of the values provided by the SaveFileFormat enumeration type.

The following lines of code create a simple project file in XML format.

Create an Empty Project And Saving as XML File

Project project = new Project();
project.Save("EmptyProjectSaveXML_out.xml", SaveFileFormat.XML);

The resulting XML project file can be opened in Microsoft Project using the following steps:

1. On the File menu, select Open.
2. Select the XML format (*.xml) option from the file types and browse to the output XML file.
3. On the Project menu, select Project Information

Create an Empty Project and Save to Stream

// Create a project instance
Project newProject = new Project();

// Create a file stream
using (FileStream stream = new FileStream("EmptyProjectSaveStream_out.xml", FileMode.Create, FileAccess.Write))
{
    // Write the stream into XML format
    newProject.Save(stream, SaveFileFormat.XML);
}

Create an Empty Project and Save to MPP

// there is no more need to load MPP template to save it into MPP
// add tasks, resources, etc.
Project project = new Project();

// !The project will be saved into MPP by using internal MPP template.
project.Save("New Project.mpp", SaveFileFormat.MPP);

Reading a Project File

Aspose.Tasks for .NET lets you read existing project in different formats: XML, MPP, MPT, MPX, XER, Primavera P6 XML, etc and save these back in MPP or another format after updating. The following snippets show how a project file can be read using the Project class’s constructor.

Reading Project Files as a Template

// Read existing project template file
Project project = new Project("New Project.mpp");

Reading Project File from Stream

// Read the project xml into file stream
using (FileStream stream = new FileStream("ReadProjectFileFromStream.xml", FileMode.Open))
{
    // Create project using file stream
    Project project = new Project(stream);
}

Importing Project Data From Microsoft Project Server Database

We plan to retire the importing of project data from Microsoft Project Server Database in a future release. Instead you can use import \ export of project data using Microsoft Project Server’s PWA API.

See documentation for ProjectServerManager class for more details.

// Create connection string
SqlConnectionStringBuilder sqlConnectionString = new SqlConnectionStringBuilder();
sqlConnectionString.DataSource = "192.168.56.2,1433";
sqlConnectionString.Encrypt = true;
sqlConnectionString.TrustServerCertificate = true;
sqlConnectionString.InitialCatalog = "ProjectServer_Published";
sqlConnectionString.NetworkLibrary = "DBMSSOCN";
sqlConnectionString.UserID = "sa";
sqlConnectionString.Password = "*****";

// Use Aspose.Tasks.Connectivity namespace
MspDbSettings settings = new MspDbSettings(sqlConnectionString.ConnectionString, new Guid("E6426C44-D6CB-4B9C-AF16-48910ACE0F54"));
Project project = new Project(settings);

Import Project Data from MPD (Microsoft Project Database) File

DbSettings settings = new MpdSettings("Provider=Microsoft.Jet.OLEDB.4.0; Data Source=" + "MpdFileToRead.mpd", 1);
Project project = new Project(settings);

Ignoring invalid characters during loading Project

Some files may have invalid characters in the custom fields. Microsoft Project does not allow invalid character so the files have been created or manipulated with automation or some other tools. If these be loaded using the API, they may lead to an exception. In order to ignore such invalid characters, the overloaded constructor of Project class can be used with the delegate method ParseErrorCallBack.

static void Run()
{
    // Open modified xml stream
    using (MemoryStream stream = new MemoryStream(Encoding.UTF8.GetBytes(GetModifiedXml())))
    {
        Project project = new Project(stream, new ParseErrorCallback(CustomDurationHandler));
    }
}

static string GetModifiedXml()
{
    // Open valid xml file and modify it
    using (TextReader reader = new StreamReader("IgnoreInvalidCharacters.xml"))
    {
        string xml = reader.ReadToEnd();
        Regex regex = new Regex("PT(\\d+)H(\\d+)M(\\d+)S");
        return regex.Replace(xml, "**$1Hrs$2Mins$3Secs**");
    }
}

static object CustomDurationHandler(object sender, ParseErrorArgs args)
{
    Regex regex = new Regex("[*]{2}(\\d+)Hrs(\\d+)Mins(\\d+)Secs[*]{2}");
    if (args.FieldType == typeof(TimeSpan))
    {
        Debug.Print("Object field : {0}, Invalid value : {1}", args.FieldName, args.InvalidValue);
        string duration = regex.Replace(args.InvalidValue, "PT$1H$2M$3S");
        TimeSpan newValue = Duration.ParseTimeSpan(duration);
        Debug.Print("New value : {0}", newValue);
        return newValue;
    }
    // Here we handle only TimeSpan instances, so rethrow original exception with other types
    throw args.Exception;
}

Working With Encodings

Aspose.Tasks for .NET provides support for the encoding of MPX files. The following code example shows the encoding settings.

// Specify Encodings
using (StreamReader streamReader = new StreamReader("Project.mpx", System.Text.Encoding.GetEncoding("ISO-8859-1")))
{
    Project project = new Project(streamReader.BaseStream);
}