Project
Contents
[
Hide
]Project class
Represents a project.
The Project is a central class in the Aspose.Tasks library.
One can use Project to read one of supported project management formats: MPP, MPT, MPX, XML.
To load an existing document in any of the supported formats, pass a file name or a stream into one of the Project constructors. To create a blank project, call the parameterless constructor.
Use one of the Save method overloads to save the project in any of the Aspose::Tasks::Saving::SaveFileFormat formats: Primavera: P6 XML, PM XER; Microsoft Excel: XLSX, XML; Fixed Layout: PDF; Images: JPEG, PNG, BMP, TIFF, SVG; Text: TXT; Others: HTML.
The Project stores project-wide information such as Aspose::Tasks::Project::Views , Aspose::Tasks::Project::BuiltInProps , Aspose::Tasks::Project::CustomProps , and Aspose::Tasks::Project::ExtendedAttributes . Most of these objects are accessible via the corresponding properties of the Project class.
The Project is a root entity that contains entry points to manipulate other project entities, such as Aspose::Tasks::Task , Aspose::Tasks::Resource , Aspose::Tasks::ResourceAssignment , Aspose::Tasks::ExtendedAttribute and Aspose::Tasks::Calendar .
The Project entities can be accessed via typed collections, for example Aspose::Tasks::Task::Children , Aspose::Tasks::Project::Resources , Aspose::Tasks::Project::ResourceAssignments , etc.
Constructors
| Name | Description |
|---|---|
| Project (13 overloads) | Initializes a new instance of the Project class. |
Methods
| Name | Description |
|---|---|
| CopyTo (2 overloads) | Copies project’s main data and properties to another project. |
| EnumerateAllChildTasks | Recursively enumerates all project’s tasks including root task. |
| Get | Returns the value to which the property is mapped in this container. |
| get_ActualsInSync | Gets a value indicating whether ActualsInSync is set or not. |
| get_AdminProject | Gets a value indicating whether AdminProject is set or not. |
| get_AreEditableActualCosts | Gets a value indicating whether AreEditableActualCosts is set or not. |
| get_Author | Gets a value of Author. |
| get_AutoAddNewResourcesAndTasks | Gets a value indicating whether AutoAddNewResourcesAndTasks is set or not. |
| get_AutoCalculateAssignmentCosts | Gets whether assignment cost and remaining cost should be auto calculated using assignment’s work and resource rates. |
| get_Autolink | Gets a value indicating whether Autolink is set or not. |
| get_BaselineForEarnedValue | Gets a value of BaselineForEarnedValue. |
| get_BuiltInProps | Gets project’s built-in properties collection. |
| get_CalculationMode | Gets calculation mode of a project. Can be one of the values of CalculationMode enumeration. |
| get_Calendar | Gets a value of Calendar . |
| get_Calendars | Gets CalendarCollection object of this Project instance. |
| get_Category | Gets a value of Category. |
| get_Comments | Gets a value of Comments. |
| get_Company | Gets a value of Company. |
| get_CreationDate | Gets a value of CreationDate. |
| get_CriticalPath | Gets a collection which contains a list of Critical tasks which comprise Critical Path of this project. |
| get_CriticalSlackLimit | Gets a value of CriticalSlackLimit. |
| get_CurrencyCode | Gets a value of CurrencyCode. |
| get_CurrencyDigits | Gets a value of CurrencyDigits. |
| get_CurrencySymbol | Gets a value of CurrencySymbol. |
| get_CurrencySymbolPosition | Gets a value of CurrencySymbolPosition. |
| get_CurrentDate | Gets a value of CurrentDate. |
| get_CustomDateFormat | Gets a value of CustomDateFormat. |
| get_CustomProps | Gets project’s custom properties collection. |
| get_DateFormat | Gets a value of DateFormat. |
| get_DaysPerMonth | Gets a value of DaysPerMonth. |
| get_DefaultFinishTime | Gets a value of DefaultFinishTime. |
| get_DefaultFixedCostAccrual | Gets a value of DefaultFixedCostAccrual. |
| get_DefaultOvertimeRate | Gets a value of DefaultOvertimeRate. |
| get_DefaultStandardRate | Gets a value of DefaultStandardRate. |
| get_DefaultStartTime | Gets a value of DefaultStartTime. |
| get_DefaultTaskEVMethod | Gets a value of DefaultTaskEVMethod. |
| get_DefaultTaskType | Gets a value of DefaultTaskType. |
| get_DefaultView | Gets default view of the project. |
| get_DefaultWeekWorkingDays | Gets the instance of WeekDayCollection class which represents a collection of project default week working days and working times. |
| get_DisplayOptions | Gets an instance of the ProjectDisplayOptions class. |
| get_DurationFormat | Gets a value of DurationFormat. |
| get_EarnedValueMethod | Gets a value of EarnedValueMethod. |
| get_ExtendedAttributes | Gets ExtendedAttributeDefinitionCollection object. The collection of extended attribute (custom fields) definitions associated with a project. |
| get_ExtendedCreationDate | Gets a value of ExtendedCreationDate. |
| get_FinishDate | Gets a value of FinishDate. |
| get_FiscalYearStart | Gets a value indicating whether FiscalYearStart is set or not. |
| get_FyStartDate | Gets a value of FyStartDate. |
| get_Guid | Gets a value of Guid. |
| get_HonorConstraints | Gets a value indicating whether HonorConstraints is set or not. |
| get_HyperlinkBase | Gets a value of HyperlinkBase. |
| get_InsertedProjectsLikeSummary | Gets a value indicating whether InsertedProjectsLikeSummary is set or not. |
| get_KeepTaskOnNearestWorkingTimeWhenMadeAutoScheduled | Gets a value indicating whether KeepTaskOnNearestWorkingTimeWhenMadeAutoScheduled is set or not. |
| get_Keywords | Gets a value of Keywords. |
| get_LastAuthor | Gets a value of LastAuthor. |
| get_LastPrinted | Gets a value of LastPrinted. |
| get_LastSaved | Gets a value of LastSaved. |
| get_Manager | Gets a value of Manager. |
| get_MicrosoftProjectServerURL | Gets a value indicating whether MicrosoftProjectServerURL is set or not. |
| get_MinutesPerDay | Gets a value of MinutesPerDay. |
| get_MinutesPerWeek | Gets a value of MinutesPerWeek. |
| get_MoveCompletedEndsBack | Gets a value indicating whether MoveCompletedEndsBack is set or not. |
| get_MoveCompletedEndsForward | Gets a value indicating whether MoveCompletedEndsForward is set or not. |
| get_MoveRemainingStartsBack | Gets a value indicating whether MoveRemainingStartsBack is set or not. |
| get_MoveRemainingStartsForward | Gets a value indicating whether MoveRemainingStartsForward is set or not. |
| get_MultipleCriticalPaths | Gets a value indicating whether MultipleCriticalPaths is set or not. |
| get_Name | Gets a value of Name. |
| get_NewTasksAreManual | Gets a value indicating whether NewTasksAreManual is set or not. |
| get_NewTasksEffortDriven | Gets a value indicating whether NewTasksEffortDriven is set or not. |
| get_NewTasksEstimated | Gets a value indicating whether NewTasksEstimated is set or not. |
| get_NewTaskStartDate | Gets a value of NewTaskStartDate. |
| get_OleObjects | Gets a collection containing the instances of the OleObject class which are linked or embedded to this project file. |
| get_OutlineCodes | Gets OutlineCodeDefinitionCollection object. The collection of outline code definitions associated with a project. |
| get_PrimaveraProperties | Gets an object containing Primavera-specific properties for a project read from Primavera file. |
| get_ProjectExternallyEdited | Gets a value indicating whether ProjectExternallyEdited is set or not. |
| get_RemoveFileProperties | Gets a value indicating whether RemoveFileProperties is set or not. |
| get_ResourceAssignments | Gets ResourceAssignmentCollection object. |
| get_ResourceFilters | Gets all the resource-based filter definitions. ResourceFilters is a collection of Filter objects. |
| get_ResourceGroups | Gets all of the resource-based group definitions. ResourceGroups is a collection of Group objects. |
| get_Resources | Gets ResourceCollection object. |
| get_Revision | Gets a value of Revision. |
| get_RootTask | Gets the root of the tree of tasks. |
| get_SaveVersion | Gets a value of SaveVersion. |
| get_ScheduleFromStart | Gets a value indicating whether ScheduleFromStart is set or not. |
| get_ShowProjectSummaryTask | Gets a value indicating whether ShowProjectSummaryTask is set or not. |
| get_SplitsInProgressTasks | Gets a value indicating whether SplitsInProgressTasks is set or not. |
| get_SpreadActualCost | Gets a value indicating whether SpreadActualCost is set or not. |
| get_SpreadPercentComplete | Gets a value indicating whether SpreadPercentComplete is set or not. |
| get_StartDate | Gets a value of StartDate. |
| get_StatusDate | Gets a value of StatusDate. |
| get_Subject | Gets a value of Subject. |
| get_Tables | Gets a list of Table objects. |
| get_TaskFilters | Gets all the task-based filter definitions. TaskFilters is a collection of Filter objects. |
| get_TaskGroups | Gets all the task-based group definitions. TaskGroups is a collection of Group objects. |
| get_TaskLinks | Gets TaskLinkCollection object. |
| get_TaskUpdatesResource | Gets a value indicating whether TaskUpdatesResource is set or not. |
| get_Template | Gets a value of Template. |
| get_TimescaleFinish | Gets a value of TimescaleFinish. |
| get_TimescaleStart | Gets a value of TimescaleStart. |
| get_Title | Gets a value of Title. |
| get_Uid | Gets a value of Uid. |
| get_UpdateManuallyScheduledTasksWhenEditingLinks | Gets a value indicating whether UpdateManuallyScheduledTasksWhenEditingLinks is set or not. |
| get_VbaProject | Gets an instance of VbaProject class. |
| get_Views | Gets a list of View objects. |
| get_WBSCodeDefinition | Gets WBS Code Definition for the project. |
| get_WeekStartDay | Gets a value of WeekStartDay. |
| get_WorkFormat | Gets a value of WorkFormat. |
| GetBaselineSaveTime | Returns the baseline save time. |
| GetDuration (3 overloads) | Gets Duration object with the specified number of units and default duration format which is defined in project’s settings Prj::DurationFormat . |
| GetPageCount (7 overloads) | Returns page count for the project to be rendered using default Timescale (Days). |
| GetPredecessors | Returns a collection of task links which are predecessors of the specified task. |
| GetProjectFileInfo (2 overloads) | Gets project file info from the stream. |
| GetWork | Gets Duration object with the specified double value and default work format. |
| Recalculate (2 overloads) | Reschedules all project tasks ids, outline levels, start/finish dates, sets early/late dates, calculates slacks, work and cost fields. |
| RecalculateResourceFields | Recalculates Id, Start and Finish of resources. |
| RecalculateResourceStartFinish | Recalculates Start and Finish of resources. |
| RemoveInvalidResourceAssignments | Eliminates invalid resource assignments from the project resource assignments list. |
| RenumberWBSCode (2 overloads) | Renumber WBS code of all tasks. |
| RescheduleUncompletedWorkToStartAfter (2 overloads) | Reschedules uncompleted project work to start after a specified date. |
| Save (5 overloads) | Saves the project to a stream using the specified save options. |
| SaveAsTemplate (4 overloads) | Saves the project as a template to a specified stream. |
| SaveReport (4 overloads) | Saves the project overview report to the stream. |
| SelectAllChildTasks | Recursively collects all child tasks of the root task. |
| Set (2 overloads) | Maps the specified property to the specified value in this container. |
| set_ActualsInSync | Sets a value indicating whether ActualsInSync is set or not. |
| set_AdminProject | Sets a value indicating whether AdminProject is set or not. |
| set_AreEditableActualCosts | Sets a value indicating whether AreEditableActualCosts is set or not. |
| set_Author | Sets a value of Author. |
| set_AutoAddNewResourcesAndTasks | Sets a value indicating whether AutoAddNewResourcesAndTasks is set or not. |
| set_AutoCalculateAssignmentCosts | Sets whether assignment cost and remaining cost should be auto calculated using assignment’s work and resource rates. |
| set_Autolink | Sets a value indicating whether Autolink is set or not. |
| set_BaselineForEarnedValue | Sets a value of BaselineForEarnedValue. |
| set_CalculationMode | Sets calculation mode of a project. Can be one of the values of CalculationMode enumeration. |
| set_Calendar | Sets a value of Calendar . |
| set_Category | Sets a value of Category. |
| set_Comments | Sets a value of Comments. |
| set_Company | Sets a value of Company. |
| set_CreationDate | Sets a value of CreationDate. |
| set_CriticalSlackLimit | Sets a value of CriticalSlackLimit. |
| set_CurrencyCode | Sets a value of CurrencyCode. |
| set_CurrencyDigits | Sets a value of CurrencyDigits. |
| set_CurrencySymbol | Sets a value of CurrencySymbol. |
| set_CurrencySymbolPosition | Sets a value of CurrencySymbolPosition. |
| set_CurrentDate | Sets a value of CurrentDate. |
| set_CustomDateFormat | Sets a value of CustomDateFormat. |
| set_DateFormat | Sets a value of DateFormat. |
| set_DaysPerMonth | Sets a value of DaysPerMonth. |
| set_DefaultFinishTime | Sets a value of DefaultFinishTime. |
| set_DefaultFixedCostAccrual | Sets a value of DefaultFixedCostAccrual. |
| set_DefaultOvertimeRate | Sets a value of DefaultOvertimeRate. |
| set_DefaultStandardRate | Sets a value of DefaultStandardRate. |
| set_DefaultStartTime | Sets a value of DefaultStartTime. |
| set_DefaultTaskEVMethod | Sets a value of DefaultTaskEVMethod. |
| set_DefaultTaskType | Sets a value of DefaultTaskType. |
| set_DefaultView | Sets default view of the project. |
| set_DurationFormat | Sets a value of DurationFormat. |
| set_EarnedValueMethod | Sets a value of EarnedValueMethod. |
| set_ExtendedCreationDate | Sets a value of ExtendedCreationDate. |
| set_FinishDate | Sets a value of FinishDate. |
| set_FiscalYearStart | Sets a value indicating whether FiscalYearStart is set or not. |
| set_FyStartDate | Sets a value of FyStartDate. |
| set_Guid | Sets a value of Guid. |
| set_HonorConstraints | Sets a value indicating whether HonorConstraints is set or not. |
| set_HyperlinkBase | Sets a value of HyperlinkBase. |
| set_InsertedProjectsLikeSummary | Sets a value indicating whether InsertedProjectsLikeSummary is set or not. |
| set_KeepTaskOnNearestWorkingTimeWhenMadeAutoScheduled | Sets a value indicating whether KeepTaskOnNearestWorkingTimeWhenMadeAutoScheduled is set or not. |
| set_Keywords | Sets a value of Keywords. |
| set_LastAuthor | Sets a value of LastAuthor. |
| set_LastPrinted | Sets a value of LastPrinted. |
| set_LastSaved | Sets a value of LastSaved. |
| set_Manager | Sets a value of Manager. |
| set_MicrosoftProjectServerURL | Sets a value indicating whether MicrosoftProjectServerURL is set or not. |
| set_MinutesPerDay | Sets a value of MinutesPerDay. |
| set_MinutesPerWeek | Sets a value of MinutesPerWeek. |
| set_MoveCompletedEndsBack | Sets a value indicating whether MoveCompletedEndsBack is set or not. |
| set_MoveCompletedEndsForward | Sets a value indicating whether MoveCompletedEndsForward is set or not. |
| set_MoveRemainingStartsBack | Sets a value indicating whether MoveRemainingStartsBack is set or not. |
| set_MoveRemainingStartsForward | Sets a value indicating whether MoveRemainingStartsForward is set or not. |
| set_MultipleCriticalPaths | Sets a value indicating whether MultipleCriticalPaths is set or not. |
| set_Name | Sets a value of Name. |
| set_NewTasksAreManual | Sets a value indicating whether NewTasksAreManual is set or not. |
| set_NewTasksEffortDriven | Sets a value indicating whether NewTasksEffortDriven is set or not. |
| set_NewTasksEstimated | Sets a value indicating whether NewTasksEstimated is set or not. |
| set_NewTaskStartDate | Sets a value of NewTaskStartDate. |
| set_ProjectExternallyEdited | Sets a value indicating whether ProjectExternallyEdited is set or not. |
| set_RemoveFileProperties | Sets a value indicating whether RemoveFileProperties is set or not. |
| set_Revision | Sets a value of Revision. |
| set_SaveVersion | Sets a value of SaveVersion. |
| set_ScheduleFromStart | Sets a value indicating whether ScheduleFromStart is set or not. |
| set_ShowProjectSummaryTask | Sets a value indicating whether ShowProjectSummaryTask is set or not. |
| set_SplitsInProgressTasks | Sets a value indicating whether SplitsInProgressTasks is set or not. |
| set_SpreadActualCost | Sets a value indicating whether SpreadActualCost is set or not. |
| set_SpreadPercentComplete | Sets a value indicating whether SpreadPercentComplete is set or not. |
| set_StartDate | Sets a value of StartDate. |
| set_StatusDate | Sets a value of StatusDate. |
| set_Subject | Sets a value of Subject. |
| set_TaskUpdatesResource | Sets a value indicating whether TaskUpdatesResource is set or not. |
| set_Template | Sets a value of Template. |
| set_TimescaleFinish | Sets a value of TimescaleFinish. |
| set_TimescaleStart | Sets a value of TimescaleStart. |
| set_Title | Sets a value of Title. |
| set_Uid | Sets a value of Uid. |
| set_UpdateManuallyScheduledTasksWhenEditingLinks | Sets a value indicating whether UpdateManuallyScheduledTasksWhenEditingLinks is set or not. |
| set_WBSCodeDefinition | Sets WBS Code Definition for the project. |
| set_WeekStartDay | Sets a value of WeekStartDay. |
| set_WorkFormat | Sets a value of WorkFormat. |
| SetBaseline (2 overloads) | Saves baseline fields to the specified baseline for the entire project. |
| SetBaselineSaveTime | Sets the baseline save time. |
| UpdateProjectWorkAsComplete (2 overloads) | Updates all work as complete through a specified date for the entire project. |