Migrate to Aspose.Tasks for .NET 8.0+

Aspose.Tasks for .NET 8.0.0 is a revamped version of the API that includes considerable changes from usage perspective. Key differences of both the implementations include:

Legacy API allowed to set public fields of various project data classes such as Project, Tasks, Resource, etc. while the new implementation introduces Set and Get methods to achieve the same
Recalculate methods required to be called manually by user in the legacy API after certain operations such as Resource Assignments. The new Aspose.Tasks for .NET API performs most of such calculations automatically without user intervention required.
The new API provides manual as well as automatic recalculation modes similar to Microsoft Project (MSP). Manual mode calculates only the necessary fields whereas automatic mode recalculates everything. This eliminates the need of calling recalculating methods manually and improves overall API usage.

This new API is incompatible with the Legacy API and the objective of this article is to help you migrate your code to the new API. The article shows comparative code samples of the Legacy and the new API implementation, and includes:

Setting Default Project Properties

Aspose.Tasks’ legacy API allowed setting default properties of a project by directly setting the public attributes of the Project class. In the new API implementation, however, it exposes Set and Get methods to achieve the same.

Legacy API Code Sample

 1Project prj = new Project();
 2
 3prj.IsScheduleFromStart = true;
 4
 5prj.StartDate = DateTime.Now;
 6
 7prj.DefaultStartTime = prj.StartDate;
 8
 9prj.DefaultTaskType = TaskType.FixedDuration;
10
11prj.DefaultStandardRate = 15;
12
13prj.DefaultOvertimeRate = 12;
14
15prj.DefaultTaskEVMethod = EarnedValueMethodType.PercentComplete;
16
17prj.DefaultFixedCostAccrual = CostAccrualType.Prorated;
18
19prj.Save( "Project4.xml" , Aspose.Tasks.Saving.SaveFileFormat.XML);

 1'Create a project instance
 2
 3Dim prj As New Project()
 4
 5prj.IsScheduleFromStart = True
 6
 7prj.StartDate = DateTime.Now
 8
 9prj.DefaultStartTime = prj.StartDate
10
11prj.DefaultTaskType = TaskType.FixedDuration
12
13prj.DefaultStandardRate = 15
14
15prj.DefaultOvertimeRate = 12
16
17prj.DefaultTaskEVMethod = EarnedValueMethodType.PercentComplete
18
19prj.DefaultFixedCostAccrual = CostAccrualType.Prorated
20
21prj.Save("Project4.xml", Aspose.Tasks.Saving.SaveFileFormat.XML)

New Aspose.Tasks for .NET 8.x Approach

 1Project project = new Project();
 2
 3project.Set(Prj.ScheduleFromStart,true);
 4
 5project.Set(Prj.StartDate, DateTime.Now);
 6
 7project.Set(Prj.DefaultStartTime,project.Get(Prj.StartDate));
 8
 9project.Set(Prj.DefaultTaskType, TaskType.FixedDuration);
10
11project.Set(Prj.DefaultStandardRate, 15);
12
13project.Set(Prj.DefaultOvertimeRate, 12);
14
15project.Set(Prj.DefaultTaskEVMethod, EarnedValueMethodType.PercentComplete);
16
17project.Set(Prj.DefaultFixedCostAccrual, CostAccrualType.Prorated);
18
19project.Save("ProjectDefaultProps.xml", SaveFileFormat.XML);

 1Dim project As New Project()
 2
 3project.[Set](Prj.ScheduleFromStart, True)
 4
 5project.[Set](Prj.StartDate, DateTime.Now)
 6
 7project.[Set](Prj.DefaultStartTime, project.[Get](Prj.StartDate))
 8
 9project.[Set](Prj.DefaultTaskType, TaskType.FixedDuration)
10
11project.[Set](Prj.DefaultStandardRate, 15)
12
13project.[Set](Prj.DefaultOvertimeRate, 12)
14
15project.[Set](Prj.DefaultTaskEVMethod, EarnedValueMethodType.PercentComplete)
16
17project.[Set](Prj.DefaultFixedCostAccrual, CostAccrualType.Prorated)
18
19project.Save("ProjectDefaultProps.xml", SaveFileFormat.XML)

Creating and Adding Calendar to a Project

In order for proper functionality of Calendar items added to the Project, the legacy API required to recalculate Calendar UIDs. In the new API, however, UIDs recalculation are automatically dealt and there is no need to call the calculations manually.

Legacy API Code Sample

 1Project prj =  new Project();
 2
 3Aspose.Tasks.Calendar cal1 = new  Aspose.Tasks.Calendar();
 4
 5cal1.Name ="no info";
 6
 7Aspose.Tasks.Calendar cal2 = new  Aspose.Tasks.Calendar(1);
 8
 9cal2.Name = "no name";
10
11Aspose.Tasks.Calendar cal3 = new  Aspose.Tasks.Calendar( "cal3" );
12
13prj.Calendars.Add(cal1);
14
15prj.Calendars.Add(cal2);
16
17prj.Calendars.Add(cal3);
18
19prj.CalcCalendarUids();
20
21prj.Save( "Project.Xml", Aspose.Tasks.Saving.SaveFileFormat.XML);

 1'Create a project instance
 2
 3Dim prj As New Project()
 4
 5'Define Calendar
 6
 7Dim cal1 As New Aspose.Tasks.Calendar()
 8
 9cal1.Name = "no info"
10
11Dim cal2 As New Aspose.Tasks.Calendar(1)
12
13cal2.Name = "no name"
14
15Dim cal3 As New Aspose.Tasks.Calendar("cal3")
16
17prj.Calendars.Add(cal1)
18
19prj.Calendars.Add(cal2)
20
21prj.Calendars.Add(cal3)
22
23prj.CalcCalendarUids()
24
25'Save the Project
26
27prj.Save("Project.Xml", Aspose.Tasks.Saving.SaveFileFormat.XML)

New Aspose.Tasks for .NET 8.x Approach

 1//Create a project instance
 2
 3Project prj = new Project();
 4
 5Aspose.Tasks.Calendar cal1 = prj.Calendars.Add("no info");
 6
 7Aspose.Tasks.Calendar cal2 = prj.Calendars.Add("no name");
 8
 9Aspose.Tasks.Calendar cal3 = prj.Calendars.Add("cal3");
10
11prj.Save("Project.Xml", Aspose.Tasks.Saving.SaveFileFormat.XML);

 1'Create a project instance
 2
 3Dim prj As New Project()
 4
 5Dim cal1 As Aspose.Tasks.Calendar = prj.Calendars.Add("no info")
 6
 7Dim cal2 As Aspose.Tasks.Calendar = prj.Calendars.Add("no name")
 8
 9Dim cal3 As Aspose.Tasks.Calendar = prj.Calendars.Add("cal3")
10
11prj.Save("Project.Xml", Aspose.Tasks.Saving.SaveFileFormat.XML)

Making A Standard Calendar

Recalculating Calendar UIDs are no more required in the new ASpose.Tasks’ API as compared to the legacy API.

Legacy API Code Sample

 1//Create a project instance
 2
 3Project prj = new  Project();
 4
 5//Define Calendar and make it standard
 6
 7Aspose.Tasks.Calendar cal1 = new  Aspose.Tasks.Calendar("My Cal");
 8
 9Aspose.Tasks.Calendar.MakeStandardCalendar(cal1);
10
11prj.Calendars.Add(cal1);
12
13prj.CalcCalendarUids();
14
15prj.Save( "Project.Xml" , Aspose.Tasks.Saving.SaveFileFormat.XML);

 1'Create a project instance
 2
 3Dim prj As New Project()
 4
 5'Define Calendar and make it standard
 6
 7Dim cal1 As New Aspose.Tasks.Calendar("My Cal")
 8
 9Aspose.Tasks.Calendar.MakeStandardCalendar(cal1)
10
11prj.Calendars.Add(cal1)
12
13prj.CalcCalendarUids()
14
15'Save the Project
16
17prj.Save("Project.Xml", Aspose.Tasks.Saving.SaveFileFormat.XML)

New Aspose.Tasks for .NET 8.x Approach

 1// Create a project instance
 2
 3Project project = new Project();
 4
 5// Define Calendar and make it standard
 6
 7Aspose.Tasks.Calendar cal1 = project.Calendars.Add("My Cal");
 8
 9Aspose.Tasks.Calendar.MakeStandardCalendar(cal1);
10
11project.Save("Project.Xml", Aspose.Tasks.Saving.SaveFileFormat.XML);

 1'Create a project instance
 2
 3Dim project As New Project()
 4
 5'Define Calendar and make it standard
 6
 7Dim cal1 As Aspose.Tasks.Calendar = project.Calendars.Add("My Cal")
 8
 9Aspose.Tasks.Calendar.MakeStandardCalendar(cal1)
10
11'Save the Project
12
13project.Save("Project.Xml", Aspose.Tasks.Saving.SaveFileFormat.XML)

Create and Add Task to Project

Creating a new task in the legacy API, it required to define a root task, add it to the project as its root task, and then add a new task to this root task as a child. The new API, however, doesn’t need you to define the root task and takes care of it automatically while adding the first task to the project.

Legacy API Code Sample

 1Project project = new Project();
 2
 3Task rootTask = new Task();
 4
 5Task tskGen = new Task("Task1");
 6
 7tskGen.Id = 1;
 8
 9tskGen.Uid = 1;
10
11tskGen.Start = DateTime.Parse("17-Aug-2009 8:00 AM" );
12
13tskGen.Finish = DateTime.Parse( "17-Aug-2009 5:00 PM" );
14
15project.RootTask = rootTask;
16
17project.RootTask.Children.Add(tskGen);
18
19project.Save("Project.xml", SaveFileFormat.XML);

 1Dim project As New Project()
 2
 3Dim tskGen As New Task("Task1")
 4
 5tskGen.Id = 1
 6
 7tskGen.Uid = 1
 8
 9tskGen.Start = DateTime.Parse("17-Aug-2009 8:00 AM")
10
11tskGen.Finish = DateTime.Parse("17-Aug-2009 5:00 PM")
12
13project.RootTask = rootTask
14
15project.RootTask.Children.Add(tskGen)
16
17project.Save("Project.xml", SaveFileFormat.XML)

New Aspose.Tasks for .NET 8.x Approach

1Project project = new Project();
2
3Task task = project.RootTask.Children.Add("Task 1");
4
5task.Set(Tsk.Start, project.RootTask.Get(Tsk.Start).AddDays(1));
6
7// set task start day
8
9project.Save("CreateTasks.xml", SaveFileFormat.XML);

1Dim project As New Project()
2
3Dim task As Task = project.RootTask.Children.Add("Task 1")
4
5task.[Set](Tsk.Start, project.RootTask.[Get](Tsk.Start).AddDays(1))
6
7'set task start day
8
9project.Save("CreateTasks.xml", SaveFileFormat.XML)

Create and Add Resource to Project

Set and Get methods have been added to the Resource class of the API for manipulating attributes related to a project’s Resource.

Legacy API Code Sample

 1Project project = new Project();
 2
 3Resource res =   Resource(new "Res1");
 4
 5res.Id = 1;
 6
 7res.Uid = 1;
 8
 9res.Start = DateTime.Parse("19-Aug-2009 8:00 AM");
10
11res.Finish = DateTime.Parse("19-Aug-2009 5:00 PM");
12
13project.Resources.Add(res);
14
15project.Save("Project.xml", SaveFileFormat.XML);

 1Dim project As New Project()
 2
 3Dim res As New Resource("Res1")
 4
 5res.Id = 1
 6
 7res.Uid = 1
 8
 9res.Start = DateTime.Parse("19-Aug-2009 8:00 AM")
10
11res.Finish = DateTime.Parse("19-Aug-2009 5:00 PM")
12
13project.Resources.Add(res)
14
15project.Save("Project.xml", SaveFileFormat.XML)

New Aspose.Tasks for .NET 8.x Approach

1Project project = new Project();
2
3Resource rsc = project.Resources.Add("R1");
4
5rsc.Set(Rsc.Start, DateTime.Parse("31-Aug-2014 8:00 AM"));
6
7rsc.Set(Rsc.Finish, DateTime.Parse("31-Aug-2014 5:00 PM"));
8
9project.Save("CreateResource.xml", SaveFileFormat.XML);

1Dim project As New Project()
2
3Dim rsc As Resource = project.Resources.Add("R1")
4
5rsc.[Set](Rsc.Start, DateTime.Parse("31-Aug-2014 8:00 AM"))
6
7rsc.[Set](Rsc.Finish, DateTime.Parse("31-Aug-2014 5:00 PM"))
8
9project.Save("CreateResource.xml", SaveFileFormat.XML)

Create and Add Resource Assignment to Project

The ResourceAssignment class also introduces the Set and Get methods similar to other data collections of the API such as Tasks, Resources and Tasks Links.

Legacy API Code Sample

 1Project project = new Project();
 2
 3Task tskRoot =  new Task();
 4
 5Task task = new Task("Task");
 6
 7Resource rsc = new Resource();
 8
 9rsc.StandardRate = 10;
10
11rsc.OvertimeRate = 15;
12
13ResourceAssignment assignment = new ResourceAssignment(task, rsc);
14
15assignment.Uid = 1;
16
17assignment.Start = DateTime.Parse("18-Aug-2009 8:00 AM" );
18
19assignment.Finish = DateTime.Parse("18-Aug-2009 5:00 PM" );
20
21project.RootTask = tskRoot;
22
23project.RootTask.Children.Add(task);
24
25project.Resources.Add(res);
26
27project.ResourceAssignments.Add(assignment);
28
29project.Save("project.xml", SaveFileFormat.XML);

 1Dim project As New Project()
 2
 3Dim tskRoot As New Task()
 4
 5Dim task As New Task("Task")
 6
 7Dim rsc As New Resource()
 8
 9rsc.StandardRate = 10
10
11rsc.OvertimeRate = 15
12
13Dim assignment As New ResourceAssignment(task, rsc)
14
15assignment.Start = DateTime.Parse("18-Aug-2009 8:00 AM" )
16
17assignment.Finish = DateTime.Parse("18-Aug-2009 5:00 PM" )
18
19assignment.Uid = 1
20
21project.RootTask = tskRoot
22
23project.RootTask.Children.Add(task)
24
25project.Resources.Add(res)
26
27project.ResourceAssignments.Add(assignment)
28
29project.Save("project.xml", SaveFileFormat.XML)

New Aspose.Tasks for .NET 8.x Approach

 1Project project = new Project();
 2
 3Task task = project.RootTask.Children.Add("Task");
 4
 5Resource rsc = project.Resources.Add("Rsc");
 6
 7rsc.Set(Rsc.StandardRate, 10);
 8
 9rsc.Set(Rsc.OvertimeRate, 15);
10
11ResourceAssignment assignment = project.ResourceAssignments.Add(task, rsc);
12
13assignment.Set(Assn.Start,DateTime.Parse("18-Aug-2009 8:00 AM" );
14
15assignment.Set(Assn.Finish, DateTime.Parse("18-Aug-2009 5:00 PM" );
16
17project.Save("ResourceAssignments.xml", SaveFileFormat.XML);

 1Dim project As New Project()
 2
 3Dim task As Task = project.RootTask.Children.Add("Task")
 4
 5Dim rsc As Resource = project.Resources.Add("Rsc")
 6
 7rsc.[Set](Rsc.StandardRate, 10)
 8
 9rsc.[Set](Rsc.OvertimeRate, 15)
10
11Dim assignment As ResourceAssignment = project.ResourceAssignments.Add(task, rsc)
12
13assignment.Set(Assn.Start,DateTime.Parse("18-Aug-2009 8:00 AM" )
14
15assignment.Set(Assn.Finish, DateTime.Parse("18-Aug-2009 5:00 PM" ) project.Save("ResourceAssignments.xml", SaveFileFormat.XML)

Migration to the Latest Versions Rendering Gantt Charts