Skip to main content
A newer version of this page is available. .

GanttControl.UpdateSummaryProgress(GanttControlNode) Method

Updates the progress for all summary tasks in a tree branch that starts from the specified task.

Namespace: DevExpress.XtraGantt

Assembly: DevExpress.XtraGantt.v21.2.dll

NuGet Packages: DevExpress.Win.Design, DevExpress.Win.Gantt

Declaration

public void UpdateSummaryProgress(
    GanttControlNode node = null
)

Optional Parameters

Name Type Default Description
node GanttControlNode null

The summary task that is the root task in the branch that should be updated. If not specified, the method updates all the tasks in the project.

Remarks

If the UpdateDependentTaskProgress option is enabled, the control automatically recalculates the progress when changes are made. For example, when a user modifies a particular task’s progress, the control updates the progress of all dependent tasks:

  • for a regular task — the control recalculates the progress for all summary tasks (the total progress).

    Note that tasks contribute to the total progress in proportion to their duration. For example, a completed one-week task adds more to the total progress than a one-day task.

  • for a summary task (the total progress) — the control recalculates the progress for all sub-tasks and parent summary tasks.

    Note that the specified total progress is shared between sub-tasks in the order they appear in the time scale. For example, the specified progress is applied to the first task until it is complete and then the second task if there are two consecutive tasks. If there are two simultaneous tasks, the total progress is applied equally.

The CustomTaskProgress event fires when the control recalculated a dependent task’s progress. You can handle this event to specify a custom value.

If the UpdateDependentTaskProgress option is disabled or if you updated progress in the data source, the control does not update progress in dependent tasks. You can call the UpdateSummaryProgress method to update progress for all summary tasks in a tree branch that starts from the specified task. If the summary task is not specified, the method updates all tasks in the project.

See Task Progress for more information.

See Also