GanttControl.CustomTaskProgress Event

Fires when a task’s progress is recalculated and allows you to specify a custom value.

Assembly : DevExpress.XtraGantt.v25.2.dll

NuGet Package : DevExpress.Win.Gantt

Declaration

C#
VB.NET

csharp

[DXCategory("Events")]
public event CustomTaskProgressEventHandler CustomTaskProgress

<DXCategory("Events")>
Public Event CustomTaskProgress As CustomTaskProgressEventHandler

Event Data

The CustomTaskProgress event's data class is CustomTaskProgressEventArgs. The following properties provide information specific to this event:

Property	Description
Node	Gets or sets the processed node.
Progress	Gets or sets the task’s progress (a value from 0 to 1 ).

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).
for a summary task (the total progress) — the control recalculates the progress for all sub-tasks and parent summary tasks.

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.

Example

The code below handles the CustomTaskProgress event to apply a coefficient to the contribution of a particular task to the total progress.

C#
VB.NET

csharp

ganttControl1.CustomTaskProgress += GanttControl1_CustomTaskProgress;

private void GanttControl1_CustomTaskProgress(object sender, DevExpress.XtraGantt.CustomTaskProgressEventArgs e) {
    if(e.Node.HasChildren) {
        float result = 0;
        foreach(GanttControlNode node in e.Node.Nodes)
            result += (float)node["Progress"] / 100 * (float)node["ProgressCoefficient"];
        e.Progress = result;
    }
}

AddHandler ganttControl1.CustomTaskProgress, AddressOf GanttControl1_CustomTaskProgress

Private Sub GanttControl1_CustomTaskProgress(ByVal sender As Object, ByVal e As DevExpress.XtraGantt.CustomTaskProgressEventArgs)
    If e.Node.HasChildren Then
        Dim result As Single = 0
        For Each node As GanttControlNode In e.Node.Nodes
            result += DirectCast(node("Progress"), Single) / 100 * DirectCast(node("ProgressCoefficient"), Single)
        Next node
        e.Progress = result
    End If
End Sub