Working with Extended Attributes of a Project

Microsoft Project has an extensive XML data interchange schema that makes exchanging information between applications and programming with project files easier. The schema allows you to add extended attributes to tasks, resources and assignments. This article shows how to work with Extended Attributes in Aspose.Tasks.

Working with Custom Fields using Microsoft Project

In this example, we will show how to work with Text1 extended attribute of a project for associating the information with a Task.

1. In MSP, go to Project->Custom Fields.
2. From here, select Task.
3. Select Text as Custom Field Type from the Type Combo Box.
4. Select Text1 as a custom field that you want to work with
5. Use the “Rename” button to rename the alias of the field if it is desired and press OK button
6. Add a new task and insert a new column to the task row with the custom field that you used in the above step

Working with Custom Fields/Extended Attributes using Aspose.Tasks for .NET

Aspose.Tasks for .NET API provides the capability of creating new extended attributes as well as working with Extended attributes already present in a document. Custom fields or Extended Attributes are represented by ExtendedAttributes collection of a project in Aspose.Tasks. It contains all the extended attributes definition of a project document. Some of the mappings of MSP Custom Field definition are as shown in the image below.

Creating a New Extended Attribute and Adding it to Task

To add a new extended attribute for task or resource, we first need to define and add the extended attribute definition to the ExtendedAttributes collection. ExtendedAttributeDefinition class is used to define a new ExtendedAttribute in a project. The FieldId must be set for proper defining an Extended attribute which is linked to ExtendedAttributeTask (in case of Task) or ExtendedAttributeResource (in case of Resource). The following sample code shows how to define a new Extended Attribute for Text1 field of project. Once the Extended Attribute definition is complete, you can now create a new Extended Attribute from it and assign it to a task.

Project project = new Project("New Project.mpp");

ExtendedAttributeDefinition myTextAttributeDefinition = project.ExtendedAttributes.GetById((int)ExtendedAttributeTask.Text1);

// If the Custom field doesn't exist in Project, create it
if (myTextAttributeDefinition == null)
{
    myTextAttributeDefinition = ExtendedAttributeDefinition.CreateTaskDefinition(ExtendedAttributeTask.Text1, "My text field");
    project.ExtendedAttributes.Add(myTextAttributeDefinition);
}

// Generate Extended Attribute from definition
ExtendedAttribute text1TaskAttribute = myTextAttributeDefinition.CreateExtendedAttribute();

text1TaskAttribute.TextValue = "Text attribute value";

// Add extended attribute to task
Task task = project.RootTask.Children.Add("Task 1");
task.ExtendedAttributes.Add(text1TaskAttribute);

project.Save("CreateExtendedAttributes_out.mpp", SaveFileFormat.MPP);

Writing Updated Extended Attribute Definitions and Values to MPP

Aspose.Tasks for .NET supports updating extended attribute data in a Microsoft Project MPP file and save it back.

The example code below adds new extended attributes of the Resource and Task types to the source MPP file. The steps involved in this activity are:

1. Create an instance of Project Reader.
2. Read the source MPP file.
3. Define a new extended attribute and update its values.
4. Save the project using the Project Writer.

The following example shows setting the extended attributes of a resource.

Project project = new Project("New Project.mpp");

// Add new text3 extended attribute with lookup and one lookup value
ExtendedAttributeDefinition taskTextAttributeDefinition = ExtendedAttributeDefinition.CreateLookupTaskDefinition(ExtendedAttributeTask.Text3, "New text3 attribute");
taskTextAttributeDefinition.ElementType = ElementType.Task;
project.ExtendedAttributes.Add(taskTextAttributeDefinition);

Value textVal = new Value();
textVal.Id = 1;
textVal.Description = "Text value descr";
textVal.Val = "Text value1";

taskTextAttributeDefinition.AddLookupValue(textVal);

// Add new cost1 extended attribute with lookup and two cost values
ExtendedAttributeDefinition taskCostAttributeDefinition = ExtendedAttributeDefinition.CreateLookupTaskDefinition(ExtendedAttributeTask.Cost1, "New cost1 attribute");
project.ExtendedAttributes.Add(taskCostAttributeDefinition);

Value costVal1 = new Value();
costVal1.Id = 2;
costVal1.Description = "Cost value 1 descr";
costVal1.Val = "99900";

Value costVal2 = new Value();
costVal2.Id = 3;
costVal2.Description = "Cost value 2 descr";
costVal2.Val = "11100";

taskCostAttributeDefinition.AddLookupValue(costVal1);
taskCostAttributeDefinition.AddLookupValue(costVal2);

// Add new task and assign attribute lookup value.
Task task = project.RootTask.Children.Add("New task");

ExtendedAttribute taskAttr = taskCostAttributeDefinition.CreateExtendedAttribute(costVal1);
task.ExtendedAttributes.Add(taskAttr);

ExtendedAttributeDefinition taskStartAttributeDefinition = ExtendedAttributeDefinition.CreateLookupTaskDefinition(ExtendedAttributeTask.Start7, "New start 7 attribute");

Value startVal = new Value();
startVal.Id = 4;
startVal.DateTimeValue = DateTime.Now;
startVal.Description = "Start 7 value description";

taskStartAttributeDefinition.AddLookupValue(startVal);

project.ExtendedAttributes.Add(taskStartAttributeDefinition);

ExtendedAttributeDefinition taskFinishAttributeDefinition = ExtendedAttributeDefinition.CreateLookupTaskDefinition(ExtendedAttributeTask.Finish4, "New finish 4 attribute");

Value finishVal = new Value();
finishVal.Id = 5;
finishVal.DateTimeValue = DateTime.Now;
finishVal.Description = "Finish 4 value description";

taskFinishAttributeDefinition.ValueList.Add(finishVal);

project.ExtendedAttributes.Add(taskFinishAttributeDefinition);

ExtendedAttributeDefinition numberAttributeDefinition = ExtendedAttributeDefinition.CreateLookupTaskDefinition(ExtendedAttributeTask.Number20, "New number attribute");

Value val1 = new Value();
val1.Id = 6;
val1.Val = "1";
val1.Description = "Number 1 value";
Value val2 = new Value();
val2.Id = 7;
val2.Val = "2";
val2.Description = "Number 2 value";
Value val3 = new Value();
val2.Id = 8;
val3.Val = "3";
val3.Description = "Number 3 value";

numberAttributeDefinition.AddLookupValue(val1);
numberAttributeDefinition.AddLookupValue(val2);
numberAttributeDefinition.AddLookupValue(val3);

project.ExtendedAttributes.Add(numberAttributeDefinition);

ExtendedAttributeDefinition resourceStartAttributeDefinition = ExtendedAttributeDefinition.CreateLookupResourceDefinition(ExtendedAttributeResource.Start5, "New start5 attribute");

Value startVal2 = new Value();
startVal2.Id = 9;
startVal2.DateTimeValue = DateTime.Now;
startVal2.Description = "this is start5 value descr";

resourceStartAttributeDefinition.AddLookupValue(startVal2);

project.ExtendedAttributes.Add(resourceStartAttributeDefinition);

// Define a duration attribute without lookup.
ExtendedAttributeDefinition taskDurationAttributeDefinition = ExtendedAttributeDefinition.CreateTaskDefinition(ExtendedAttributeTask.Duration1, "New Duration");
project.ExtendedAttributes.Add(taskDurationAttributeDefinition);

// Add new task and assign duration value to the previously defined duration attribute.
Task timeTask = project.RootTask.Children.Add("New task");

ExtendedAttribute durationExtendedAttribute = taskDurationAttributeDefinition.CreateExtendedAttribute();

durationExtendedAttribute.DurationValue = project.GetDuration(3.0, TimeUnitType.Hour);
timeTask.ExtendedAttributes.Add(durationExtendedAttribute);

MPPSaveOptions mppSaveOptions = new MPPSaveOptions();
mppSaveOptions.WriteViewData = true;

project.Save("WriteUpdatedExtendedAttributeDefinitions_out.mpp", mppSaveOptions);