Class Task
Namespace: Aspose.Tasks
Assembly: Aspose.Tasks.dll (25.2.0)
Represents a task in a project.
public class Task : IEquatable<task>Inheritance
Implements
Inherited Members
object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
Remarks
The Task is representing a one atomic chunk of work.
One can use Task to plan a project by creating tasks and assign appropriate resources onto them. Tasks in a project are organized as a rooted hierarchical tree structure, with a root task and subtrees of children tasks.To build a tree of tasks one can use a specialized collection Aspose.Tasks.TaskCollection by accessing Aspose.Tasks.Project.RootTask property e.g.:
``` csharp Project project = new Project(); // add new tasks
Task task1 = project.RootTask.Children.Add(); // a parent task with empty name is added
Task childTask1 = task1.Children.Add("Child 1");
childTask1.Set(Tsk.Start, new DateTime(2020, 2, 12, 8, 0, 0))
childTask1.Set(Tsk.Duration, project.GetDuration(8, TimeUnitType.Hour));
childTask1.Set(Tsk.Finish, new DateTime(2020, 2, 12, 17, 0, 0));
Task childTask3 = task1.Children.Add("Child 3");
childTask3.Set(Tsk.Start, new DateTime(2020, 2, 13, 8, 0, 0))
childTask3.Set(Tsk.Duration, project.GetDuration(8, TimeUnitType.Hour));
childTask3.Set(Tsk.Finish, new DateTime(2020, 2, 13, 17, 0, 0));
Task childTask2 = task1.Children.Add("Child 2", 2); // inserts a task before the childTask3
childTask2.Set(Tsk.Start, new DateTime(2020, 2, 14, 8, 0, 0))
childTask2.Set(Tsk.Duration, project.GetDuration(8, TimeUnitType.Hour));
childTask2.Set(Tsk.Finish, new DateTime(2020, 2, 14, 17, 0, 0));
// save project in the one of available formats
project.Save("Filled project.xml", SaveFileFormat.MPP);
## Properties
### <a id="Aspose_Tasks_Task_ACWP"></a> ACWP
Gets or sets a value of ACWP.
```csharp
[EntityField]
public double ACWP { get; set; }Property Value
ActivityId
Represents activity id field - a task’s unique identifier used by Primavera. (only applicable to Primavera projects).
public string ActivityId { get; set; }Property Value
ActualCost
Gets or sets a value of ActualCost.
[EntityField]
public decimal ActualCost { get; set; }Property Value
ActualDuration
Gets or sets a value of ActualDuration.
[EntityField]
public Duration ActualDuration { get; set; }Property Value
ActualFinish
Gets or sets a value of ActualFinish.
[EntityField]
public DateTime ActualFinish { get; set; }Property Value
ActualOvertimeCost
Gets or sets a value of ActualOvertimeCost.
[EntityField]
public decimal ActualOvertimeCost { get; set; }Property Value
ActualOvertimeWork
Gets or sets a value of ActualOvertimeWork.
[EntityField]
public Duration ActualOvertimeWork { get; set; }Property Value
ActualOvertimeWorkProtected
Gets or sets a value of ActualOvertimeWorkProtected.
[EntityField]
public Duration ActualOvertimeWorkProtected { get; set; }Property Value
ActualStart
Gets or sets a value of ActualStart.
[EntityField]
public DateTime ActualStart { get; set; }Property Value
ActualWork
Gets or sets a value of ActualWork.
[EntityField]
public Duration ActualWork { get; set; }Property Value
ActualWorkProtected
Gets or sets a value of ActualWorkProtected.
[EntityField]
public Duration ActualWorkProtected { get; set; }Property Value
Assignments
Gets a collection of resource assignments for this object.
public ResourceAssignmentCollection Assignments { get; }Property Value
BCWP
Gets or sets a value of BCWP.
[EntityField]
public double BCWP { get; set; }Property Value
BCWS
Gets or sets a value of BCWS.
[EntityField]
public double BCWS { get; set; }Property Value
Baselines
Gets or sets the collection of baseline values of the task.
public TaskBaselineCollection Baselines { get; set; }Property Value
BudgetCost
Gets or sets a value of BudgetCost.
[EntityField]
public decimal BudgetCost { get; set; }Property Value
BudgetWork
Gets or sets a value of BudgetWork.
[EntityField]
public Duration BudgetWork { get; set; }Property Value
CV
Gets or sets a value of CV.
[EntityField]
public double CV { get; set; }Property Value
Calendar
Gets or sets a value of Calendar.
[EntityField]
public Calendar Calendar { get; set; }Property Value
Children
Gets a child task collection of this object. TaskCollection object which represents children tasks.
public TaskCollection Children { get; }Property Value
CommitmentFinish
Gets or sets a value of CommitmentFinish.
[EntityField]
public DateTime CommitmentFinish { get; set; }Property Value
CommitmentStart
Gets or sets a value of CommitmentStart.
[EntityField]
public DateTime CommitmentStart { get; set; }Property Value
CommitmentType
Gets or sets a value of CommitmentType.
[EntityField]
public int CommitmentType { get; set; }Property Value
ConstraintDate
Gets or sets a value of ConstraintDate.
[EntityField]
public DateTime ConstraintDate { get; set; }Property Value
ConstraintType
Gets or sets a value of ConstraintType.
[EntityField]
public ConstraintType ConstraintType { get; set; }Property Value
Contact
Gets or sets a value of Contact.
[EntityField]
public string Contact { get; set; }Property Value
Cost
Gets or sets a value of Cost.
[EntityField]
public decimal Cost { get; set; }Property Value
CostVariance
Gets or sets a value of CostVariance.
[EntityField]
public double CostVariance { get; set; }Property Value
Created
Gets or sets a value of Created.
[EntityField]
public DateTime Created { get; set; }Property Value
Deadline
Gets or sets a value of Deadline.
[EntityField]
public DateTime Deadline { get; set; }Property Value
DisplayAsSummary
Gets or sets a value indicating whether DisplayAsSummary is set or not.
[EntityField]
public NullableBool DisplayAsSummary { get; set; }Property Value
DisplayOnTimeline
Gets or sets a value indicating whether DisplayOnTimeline is set or not.
[EntityField]
public bool DisplayOnTimeline { get; set; }Property Value
Duration
Gets or sets a value of Duration.
[EntityField]
public Duration Duration { get; set; }Property Value
DurationFormat
Gets or sets a value of DurationFormat.
[Obsolete("This member is obsolete and will be removed after release 24.6. Please use Task.Duration.TimeUnit property instead.")]
[EntityField]
public TimeUnitType DurationFormat { get; set; }Property Value
DurationText
Gets or sets a value of DurationText.
[EntityField]
public string DurationText { get; set; }Property Value
DurationVariance
Gets or sets a value of DurationVariance.
[EntityField]
public Duration DurationVariance { get; set; }Property Value
EarlyFinish
Gets or sets a value of EarlyFinish.
[EntityField]
public DateTime EarlyFinish { get; set; }Property Value
EarlyStart
Gets or sets a value of EarlyStart.
[EntityField]
public DateTime EarlyStart { get; set; }Property Value
EarnedValueMethod
Gets or sets a value of EarnedValueMethod.
[EntityField]
public EarnedValueMethodType EarnedValueMethod { get; set; }Property Value
ExtendedAttributes
Gets ExtendedAttributeCollection object containing the values of an extended attribute.
public ExtendedAttributeCollection ExtendedAttributes { get; }Property Value
Remarks
Two pieces of data are necessary - a pointer back to the extended attribute table which is specified either by the unique ID or the Field ID, and the value which is specified either with the value, or a pointer back to the value list.
ExternalId
Gets or sets a value of ExternalId.
[EntityField]
public int ExternalId { get; set; }Property Value
ExternalTaskProject
Gets or sets a value of ExternalTaskProject.
[EntityField]
public string ExternalTaskProject { get; set; }Property Value
ExternalUid
Gets or set the external task’s Unique identifier when the task is external.
[EntityField]
public int ExternalUid { get; set; }Property Value
Finish
Gets or sets a value of Finish.
[EntityField]
public DateTime Finish { get; set; }Property Value
FinishSlack
Gets or sets a value of FinishSlack.
[EntityField]
public TimeSpan FinishSlack { get; set; }Property Value
FinishText
Gets or sets a value of FinishText.
[EntityField]
public string FinishText { get; set; }Property Value
FinishVariance
Gets or sets a value of FinishVariance.
[EntityField]
public Duration FinishVariance { get; set; }Property Value
FixedCost
Gets or sets a value of FixedCost.
[EntityField]
public double FixedCost { get; set; }Property Value
FixedCostAccrual
Gets or sets a value of FixedCostAccrual.
[EntityField]
public CostAccrualType FixedCostAccrual { get; set; }Property Value
FreeSlack
Gets or sets a value of FreeSlack.
[EntityField]
public TimeSpan FreeSlack { get; set; }Property Value
Guid
Gets or sets a value of Guid.
[EntityField]
public string Guid { get; set; }Property Value
HideBar
Gets or sets a value indicating whether HideBar is set or not.
[EntityField]
public NullableBool HideBar { get; set; }Property Value
Hyperlink
Gets or sets the title or explanatory text for a hyperlink associated with a task.
[EntityField]
public string Hyperlink { get; set; }Property Value
HyperlinkAddress
Gets or sets the address for a hyperlink associated with a task.
[EntityField]
public string HyperlinkAddress { get; set; }Property Value
Remarks
The full address (Hyperlink Href in Microsoft Project) of the hyperlink is a concatenation of HyperlinkAddress and HyperlinkSubAddress.
HyperlinkSubAddress
Gets or sets the specific location in a document in a hyperlink associated with a task.
[EntityField]
public string HyperlinkSubAddress { get; set; }Property Value
Remarks
The full address (Hyperlink Href in Microsoft Project) of the hyperlink is a concatenation of HyperlinkAddress and HyperlinkSubAddress.
Id
Gets or sets a value of Id.
[EntityField]
public int Id { get; set; }Property Value
IgnoreResourceCalendar
Gets or sets a value indicating whether IgnoreResourceCalendar is set or not.
[EntityField]
public NullableBool IgnoreResourceCalendar { get; set; }Property Value
IgnoreWarnings
Gets or sets a value indicating whether IgnoreWarnings is set or not.
[EntityField]
public bool IgnoreWarnings { get; set; }Property Value
IsActive
Gets or sets a value indicating whether IsActive is set or not.
[EntityField]
public NullableBool IsActive { get; set; }Property Value
IsCritical
Gets or sets a value indicating whether IsCritical is set or not.
[EntityField]
public NullableBool IsCritical { get; set; }Property Value
IsEffortDriven
Gets or sets a value indicating whether IsEffortDriven is set or not.
[EntityField]
public NullableBool IsEffortDriven { get; set; }Property Value
IsEstimated
Gets or sets a value indicating whether IsEstimated is set or not.
[EntityField]
public NullableBool IsEstimated { get; set; }Property Value
IsExpanded
Gets or sets a value indicating whether IsExpanded is set or not.
[EntityField]
public NullableBool IsExpanded { get; set; }Property Value
IsExternalTask
Gets or sets a value indicating whether IsExternalTask is set or not.
[EntityField]
public bool IsExternalTask { get; set; }Property Value
IsManual
Gets or sets a value indicating whether IsManual is set or not.
[EntityField]
public NullableBool IsManual { get; set; }Property Value
IsMarked
Gets or sets a value indicating whether IsMarked is set or not.
[EntityField]
public bool IsMarked { get; set; }Property Value
IsMilestone
Gets or sets a value indicating whether IsMilestone is set or not.
[EntityField]
public NullableBool IsMilestone { get; set; }Property Value
IsNull
Gets or sets a value indicating whether IsNull is set or not.
[EntityField]
public NullableBool IsNull { get; set; }Property Value
IsOverallocated
Gets or sets a value indicating whether IsOverallocated is set or not.
[EntityField]
public NullableBool IsOverallocated { get; set; }Property Value
IsPublished
Gets or sets a value indicating whether IsPublished is set or not.
[EntityField]
public NullableBool IsPublished { get; set; }Property Value
IsRecurring
Gets or sets a value indicating whether IsRecurring is set or not.
[EntityField]
public NullableBool IsRecurring { get; set; }Property Value
IsResumeValid
Gets or sets a value indicating whether IsResumeValid is set or not.
[EntityField]
public NullableBool IsResumeValid { get; set; }Property Value
IsRollup
Gets or sets a value indicating whether IsRollup is set or not.
[EntityField]
public NullableBool IsRollup { get; set; }Property Value
IsSubproject
Gets or sets a value indicating whether IsSubproject is set or not.
[EntityField]
public bool IsSubproject { get; set; }Property Value
IsSubprojectReadOnly
Gets or sets a value indicating whether IsSubprojectReadOnly is set or not.
[EntityField]
public NullableBool IsSubprojectReadOnly { get; set; }Property Value
IsSummary
Gets or sets a value indicating whether IsSummary is set or not.
[EntityField]
public bool IsSummary { get; set; }Property Value
LateFinish
Gets or sets a value of LateFinish.
[EntityField]
public DateTime LateFinish { get; set; }Property Value
LateStart
Gets or sets a value of LateStart.
[EntityField]
public DateTime LateStart { get; set; }Property Value
LevelAssignments
Gets or sets a value indicating whether LevelAssignments is set or not.
[EntityField]
public NullableBool LevelAssignments { get; set; }Property Value
LevelingCanSplit
Gets or sets a value indicating whether LevelingCanSplit is set or not.
[EntityField]
public NullableBool LevelingCanSplit { get; set; }Property Value
LevelingDelay
Gets or sets a value of LevelingDelay.
[EntityField]
public Duration LevelingDelay { get; set; }Property Value
ManualDuration
Gets or sets a value of ManualDuration.
[EntityField]
public Duration ManualDuration { get; set; }Property Value
ManualFinish
Gets or sets a value of ManualFinish.
[EntityField]
public DateTime ManualFinish { get; set; }Property Value
ManualStart
Gets or sets a value of ManualStart.
[EntityField]
public DateTime ManualStart { get; set; }Property Value
Name
Gets or sets a value of Name.
[EntityField]
public string Name { get; set; }Property Value
NotesRTF
Gets or sets a value of NotesRTF.
[EntityField]
public string NotesRTF { get; set; }Property Value
NotesText
Gets or sets a value of NotesText.
[EntityField]
public string NotesText { get; set; }Property Value
OutlineCodes
Gets or sets Aspose.Tasks.OutlineCodeCollection object.
public OutlineCodeCollection OutlineCodes { get; set; }Property Value
Remarks
Two pieces of data are necessary - a pointer to the outline code table that is specified by the FieldID, and the value that is specified either by the ValueID or ValueGUID pointer to the value list.
OutlineLevel
Gets or sets a value of OutlineLevel.
[EntityField]
public int OutlineLevel { get; set; }Property Value
OutlineNumber
Gets or sets a value of OutlineNumber.
[EntityField]
public string OutlineNumber { get; set; }Property Value
OvertimeCost
Gets or sets a value of OvertimeCost.
[EntityField]
public decimal OvertimeCost { get; set; }Property Value
OvertimeWork
Gets or sets a value of OvertimeWork.
[EntityField]
public Duration OvertimeWork { get; set; }Property Value
ParentProject
Gets the parent project of a task.
public Project ParentProject { get; }Property Value
Remarks
Call Project.UpdateReferences to update these properties.
ParentTask
Gets the parent task of a task.
public Task ParentTask { get; }Property Value
PercentComplete
Gets or sets a value of PercentComplete.
[EntityField]
public int PercentComplete { get; set; }Property Value
PercentWorkComplete
Gets or sets a value of PercentWorkComplete.
[EntityField]
public int PercentWorkComplete { get; set; }Property Value
PhysicalPercentComplete
Gets or sets a value of PhysicalPercentComplete.
[EntityField]
public int PhysicalPercentComplete { get; set; }Property Value
Predecessors
Gets a Aspose.Tasks.TaskCollection object which contains all predecessors of this Task object.
public TaskCollection Predecessors { get; }Property Value
PreleveledFinish
Gets or sets a value of PreleveledFinish.
[EntityField]
public DateTime PreleveledFinish { get; set; }Property Value
PreleveledStart
Gets or sets a value of PreleveledStart.
[EntityField]
public DateTime PreleveledStart { get; set; }Property Value
PrimaveraProperties
Gets an object containing Primavera-specific properties for a task read from Primavera file.
public PrimaveraTaskProperties PrimaveraProperties { get; }Property Value
Priority
Gets or sets a value of Priority.
[EntityField]
public int Priority { get; set; }Property Value
RecurringInfo
Gets the instance of Aspose.Tasks.RecurringTaskInfo class for the task which is a recurring task; if the task is not a recurring one then returns null;
public RecurringTaskInfo RecurringInfo { get; }Property Value
RegularWork
Gets or sets a value of RegularWork.
[EntityField]
public Duration RegularWork { get; set; }Property Value
RemainingCost
Gets or sets a value of RemainingCost.
[EntityField]
public decimal RemainingCost { get; set; }Property Value
RemainingDuration
Gets or sets a value of RemainingDuration.
[EntityField]
public Duration RemainingDuration { get; set; }Property Value
RemainingOvertimeCost
Gets or sets a value of RemainingOvertimeCost.
[EntityField]
public decimal RemainingOvertimeCost { get; set; }Property Value
RemainingOvertimeWork
Gets or sets a value of RemainingOvertimeWork.
[EntityField]
public Duration RemainingOvertimeWork { get; set; }Property Value
RemainingWork
Gets or sets a value of RemainingWork.
[EntityField]
public Duration RemainingWork { get; set; }Property Value
Resume
Gets or sets a value of Resume.
[EntityField]
public DateTime Resume { get; set; }Property Value
SV
The earned value schedule variance, through the project status date. Schedule variance (SV) is the difference between the BCWP and the BCWS.
public double SV { get; set; }Property Value
SplitParts
Gets a SplitPart collection that represents the portions of a task.
public SplitPartCollection SplitParts { get; }Property Value
Start
Gets or sets a value of Start.
[EntityField]
public DateTime Start { get; set; }Property Value
StartSlack
Gets or sets a value of StartSlack.
[EntityField]
public TimeSpan StartSlack { get; set; }Property Value
StartText
Gets or sets a value of StartText.
[EntityField]
public string StartText { get; set; }Property Value
StartVariance
Gets or sets a value of StartVariance.
[EntityField]
public Duration StartVariance { get; set; }Property Value
Status
Gets task status.
[EntityField]
public TaskStatus Status { get; }Property Value
StatusManager
Gets or sets a value of StatusManager.
[EntityField]
public string StatusManager { get; set; }Property Value
Stop
Gets or sets a value of Stop.
[EntityField]
public DateTime Stop { get; set; }Property Value
SubprojectName
Gets or sets a value of SubprojectName.
[EntityField]
public string SubprojectName { get; set; }Property Value
Successors
Gets a Aspose.Tasks.TaskCollection object which contains all successors of this Task object.
public TaskCollection Successors { get; }Property Value
TimephasedData
Gets or sets a TimephasedDataCollection object of this task. The time phased data block associated with a task.
public TimephasedDataCollection TimephasedData { get; set; }Property Value
Remarks
Reading supported for XML format only.
TotalSlack
Gets or sets a value of TotalSlack.
[EntityField]
public TimeSpan TotalSlack { get; set; }Property Value
Type
Gets or sets a value of Type.
[EntityField]
public TaskType Type { get; set; }Property Value
Uid
Gets or sets a value of Uid.
[EntityField]
public int Uid { get; set; }Property Value
WBS
Gets or sets a value of WBS.
[EntityField]
public string WBS { get; set; }Property Value
WBSLevel
Gets or sets a value of WBSLevel.
[EntityField]
public string WBSLevel { get; set; }Property Value
Warning
Gets or sets a value indicating whether Warning is set or not.
[EntityField]
public bool Warning { get; set; }Property Value
Work
Gets or sets a value of Work.
[EntityField]
public Duration Work { get; set; }Property Value
WorkVariance
Gets or sets a value of WorkVariance.
[EntityField]
public Duration WorkVariance { get; set; }Property Value
Methods
Clone()
Creates full copy of a task without subtasks.
public object Clone()Returns
Created copy of a task.
Delete()
Deletes a task from parent project tasks collection and all its assignments.
public void Delete()Equals(Task)
Returns a value indicating whether this instance is equal to a specified task.
public bool Equals(Task other)Parameters
other Task
The specified task to compare with this instance.
Returns
returns true if the specified task and this instance have equal unique ids.
Equals(object)
Returns a value indicating whether this instance is equal to a specified object.
public override bool Equals(object obj)Parameters
obj object
The specified object to compare with this instance.
Returns
returns true if the specified task and this instance have equal unique ids.
Get<t>(Key<t, taskkey="">)
Returns the value to which the property is mapped in this container.
public T Get<t>(Key<t, taskkey=""> key)Parameters
the specified property key. Aspose.Tasks.Tsk for getting the property key.
Returns
T
the value to which the property is mapped in this container.
Type Parameters
T
the type of the mapped value.
GetHashCode()
Returns a hash code value for this Task.
public override int GetHashCode()Returns
returns a hash code value for this object.
GetTimephasedData(DateTime, DateTime, TimephasedDataType)
Returns Aspose.Tasks.TimephasedDataCollection object with Aspose.Tasks.Task.TimephasedData values within given start and end dates of specified time-phased data type.
public TimephasedDataCollection GetTimephasedData(DateTime start, DateTime end, TimephasedDataType timephasedType)Parameters
start DateTime
The start date for the time phased data.
end DateTime
The end date for the time phased data.
timephasedType TimephasedDataType
The type of time phased data (Aspose.Tasks.TimephasedDataType).
Returns
A Aspose.Tasks.TimephasedDataCollection object with Aspose.Tasks.Task.TimephasedData values within given start and end dates of specified timephased data type.
GetTimephasedData(DateTime, DateTime)
Returns Aspose.Tasks.TimephasedDataCollection object with Aspose.Tasks.Task.TimephasedData values within given start and end dates.
public TimephasedDataCollection GetTimephasedData(DateTime start, DateTime end)Parameters
start DateTime
The start date for the time phased data.
end DateTime
The end date for the time phased data.
Returns
List of Aspose.Tasks.TimephasedData to be filled in.
MoveToSibling(Task)
Moves the current task at the same Outline Level before the specified task. If ParentProject.CalculationMode is None user should invoke Project.Recalculate() after using this method (It will reschedule all project tasks (start/finish dates, sets early/late dates) and calculate the dependent fields such as slacks, work and cost fields, outline levels). If ParentProject.CalculationMode is Manual the method will calculate only task id, outline level and outline numbers automatically. If ParentProject.CalculationMode is Automatic the method reschedules all project’s tasks automatically (start/finish dates, sets early/late dates, calculates slacks, work and cost fields, recalculates ids and outline levels).
public void MoveToSibling(Task beforeTask)Parameters
beforeTask Task
Task before which the current task will be inserted.
MoveToSibling(int)
Moves the current task at the same Outline Level before a task with the specified Id. If ParentProject.CalculationMode is None user should invoke Project.Recalculate() after using this method (It will reschedule all project tasks (start/finish dates, sets early/late dates) and calculate the dependent fields such as slacks, work and cost fields, outline levels). If ParentProject.CalculationMode is Manual the method will calculate only task id, outline level and outline numbers automatically. If ParentProject.CalculationMode is Automatic the method reschedules all project’s tasks automatically (start/finish dates, sets early/late dates, calculates slacks, work and cost fields, recalculates ids and outline levels).
public void MoveToSibling(int beforeTaskId)Parameters
beforeTaskId int
Id (Aspose.Tasks.Tsk.Id) of a task before which the current task will be inserted.
OutlineIndent()
Indents a task in the outline.
public void OutlineIndent()OutlineOutdent()
Promotes a task in the outline.
public void OutlineOutdent()SelectAllChildTasks()
Recursively collects all child tasks of this task.
public IEnumerable<task> SelectAllChildTasks()Returns
IEnumerable<Task>
A list of child tasks of this task.
Set<t>(Key<t, taskkey="">, T)
Maps the specified property to the specified value in this container.
public void Set<t>(Key<t, taskkey=""> key, T val)Parameters
the specified property key. Aspose.Tasks.Tsk for getting the property key.
val T
the value.
Type Parameters
T
the type of the mapped value.
ToString()
Returns short string representation of a task. The exact details of the representation are unspecified and subject to change.
public override string ToString()Returns
short string which represents task object. </t,></t,></t,></t></t,></t,></t,></t></task>