ContextQMD
Back to Devexpress

Interactive Editing

windowsforms-401712-controls-and-libraries-gantt-control-interactive-editing.md

latest10.7 KB
Original Source

Interactive Editing

  • Sep 03, 2021
  • 5 minutes to read

Users can edit tasks in the chart and task areas. In the task area, users can invoke a cell editor to update a task’s start/finish date, progress, or duration. In the chart area, users can move a task to a new time slot, update progress, or change a dependency via drag and drop. Changes in the chart area are automatically reflected in the task area, and vice versa.

Edits in the Chart

You can allow users to reschedule a task, update progress, and create, change, or remove a dependency. Changes are automatically reflected in the task list.

The OptionsCustomization property allows you to access the following properties:

  • AllowModifyTasks — enable this option to allow users to reschedule (resize or move) tasks.

  • AllowModifyProgress — enable this option to allow users to update a task’s progress.

  • AllowModifyDependencies — if enabled, users can change task dependencies. To remove a dependency or attach it to a different task, they need to hover the dependency line first. To create a new dependency, users need to drag points displayed at task edges.

Note

The Editable option must be enabled and the ReadOnly option must be disabled to allow users to modify tasks.

Customize Operations

The control fires events at each stage of the operation: when a user starts to modify a task, the task is being modified, the operation is canceled, or the operation is completed. You can handle the following events to customize an operation:

Task

  • TaskMoveStarted — fires when a user starts to move a task.
  • TaskMoving — repeatedly fires when a user moves a task.
  • TaskMoveCanceled — fires when a user presses Esc to cancel the operation.
  • TaskMoveCompleted — fires when a user finishes modifying a dependency. Allows you to cancel the operation.
  • TaskMoved — fires when a task is successfully moved.

Task Finish Date

Progress

Dependency

The code below shows how to highlight modified/new dependencies.

csharp
using DevExpress.XtraGantt;
using DevExpress.DXperience.Demos.CodeDemo.Data;
using DevExpress.LookAndFeel;

List<DependencyInfo> modifiedDependencies = new List<DependencyInfo>();
List<DependencyInfo> createdDependencies = new List<DependencyInfo>();
ganttControl.TaskDependencyModified += (sender, e) => {
    DependencyInfo dependency = new DependencyInfo(e.PredecessorNode.Id, e.SuccessorNode.Id);
    if(e.ChangeType == ChangeType.Modify)
        modifiedDependencies.Add(dependency);
    if(e.ChangeType == ChangeType.Create)
        createdDependencies.Add(dependency);
};
ganttControl.CustomDrawTaskDependency += (sender, e) => {
    DependencyInfo dependency = new DependencyInfo(e.PredecessorNode.Id, e.SuccessorNode.Id);
    var modifiedDependency = modifiedDependencies.FirstOrDefault(x => Equals(x, dependency));
    if(modifiedDependency != null)
        e.Appearance.BackColor = DXSkinColors.FillColors.Danger;
    var createdDependency = createdDependencies.FirstOrDefault(x => Equals(x, dependency));
    if(createdDependency != null)
        e.Appearance.BackColor = DXSkinColors.FillColors.Success;

};
vb
Imports DevExpress.XtraGantt
Imports DevExpress.DXperience.Demos.CodeDemo.Data
Imports DevExpress.LookAndFeel

Dim modifiedDependencies As New List(Of DependencyInfo)()
Dim createdDependencies As New List(Of DependencyInfo)()
AddHandler ganttControl.TaskDependencyModified, Sub(sender, e)
    Dim dependency As New DependencyInfo(e.PredecessorNode.Id, e.SuccessorNode.Id)
    If e.ChangeType = ChangeType.Modify Then
        modifiedDependencies.Add(dependency)
    End If
    If e.ChangeType = ChangeType.Create Then
        createdDependencies.Add(dependency)
    End If
End Sub
AddHandler ganttControl.CustomDrawTaskDependency, Sub(sender, e)
    Dim dependency As New DependencyInfo(e.PredecessorNode.Id, e.SuccessorNode.Id)
    Dim modifiedDependency = modifiedDependencies.FirstOrDefault(Function(x) Equals(x, dependency))
    If modifiedDependency IsNot Nothing Then
        e.Appearance.BackColor = DXSkinColors.FillColors.Danger
    End If
    Dim createdDependency = createdDependencies.FirstOrDefault(Function(x) Equals(x, dependency))
    If createdDependency IsNot Nothing Then
        e.Appearance.BackColor = DXSkinColors.FillColors.Success
    End If
End Sub

Tip

Run the Code Examples demo to see this behavior. Click Run In Visual Studio in the ribbon for source codes.

Tooltips

The control can display tooltips that describe the current operation. Depending on the operation type, tooltips can show the task’s start and finish date, progress, predecessor, or successor.

Use the InteractionTooltipLocation option to enable tooltips and specify their location in the chart: top-right, bottom-left, etc. Tooltips obtain their captions from the specified data field (InteractionTooltipTextFieldName or TextFieldName).

You can also localize the following tooltip captions:

See Localization for an example.

Edits in the Tree List

Users can invoke a cell editor to update a task’s start or finish date, progress, or duration. Changes are automatically reflected in the chart area.

Note

To allow users to modify cell values, the Editable option must be enabled. See Data Editing for more information on editing data in the tree list.

Start and Finish Date Change Mode

The TaskDateChangeMode property specifies how a task changes when a user changes the task’s start or finish date:

  • MoveTask — the control shifts a task when a user changes the task’s start or finish date.
  • UpdateDuration — the control extends/reduces a task’s duration when a user changes the task’s start or finish date.