windowsforms-devexpress-dot-xtragantt-dot-splittaskmappings.md
Gets or sets the name of the field that contains a task’s identifier.
Namespace : DevExpress.XtraGantt
Assembly : DevExpress.XtraGantt.v25.2.dll
NuGet Package : DevExpress.Win.Gantt
[DefaultValue("ID")]
[DXCategory("Mappings")]
[XtraSerializableProperty]
public string KeyFieldName { get; set; }
<DXCategory("Mappings")>
<DefaultValue("ID")>
<XtraSerializableProperty>
Public Property KeyFieldName As String
| Type | Default | Description |
|---|---|---|
| String | "ID" |
The name of the field that contains a task’s identifier.
|
The SplitTaskSource property specifies a data source that contains information about interruptions in tasks. A data source record contains information about an interruption: the task, the interruption start date, and the duration of the interruption in work hours.
The GanttControl.SplitTaskMappings property allows you to specify the following mappings to data fields:
KeyFieldName — a split task’s identifier.
StartDateFieldName — the split start date. The data source field should contain a DateTime value.
DurationFieldName — the split duration. The data source field should contain a TimeSpan value that specifies an interruption in the work time.
A task has a start date, finish date, and duration. To specify a task’s location on the time scale, you only need two of them: start and finish, or start and duration. See the following help topic for more information on how to specify the data fields that contain corresponding values: Bind to Data Source. The control calculates the unspecified parameter (duration or finish date) when tasks are loaded from the data source as follows:
Note that after tasks are loaded (finish dates/durations are calculated), the control can only update the finish date (but not the duration) when a task’s split duration is changed.
The code below shows a sample data source that contains information about task splits.
ganttControl1.SplitTaskMappings.StartDateFieldName = "StartDate";
ganttControl1.SplitTaskMappings.DurationFieldName = "Duration";
ganttControl1.SplitTaskMappings.KeyFieldName = "UID";
List<TaskSplitInfo> splitInfo = new List<TaskSplitInfo>();
splitInfo.Add(new TaskSplitInfo() { UID = "8", StartDate = tasks[8].StartDate + TimeSpan.FromHours(2), Duration = TimeSpan.FromHours(8)});
splitInfo.Add(new TaskSplitInfo() { UID = "9", StartDate = tasks[9].StartDate + TimeSpan.FromHours(5), Duration = TimeSpan.FromDays(1)});
splitInfo.Add(new TaskSplitInfo() { UID = "10", StartDate = tasks[10].StartDate + TimeSpan.FromHours(4), Duration = TimeSpan.FromHours(4) });
splitInfo.Add(new TaskSplitInfo() { UID = "10", StartDate = tasks[10].StartDate + TimeSpan.FromDays(2) + TimeSpan.FromHours(2), Duration = TimeSpan.FromHours(4) });
ganttControl1.SplitTaskSource = splitInfo;
public class TaskSplitInfo {
public string UID { get; set; }
public DateTime StartDate { get; set; }
public TimeSpan Duration { get; set; }
}
ganttControl1.SplitTaskMappings.StartDateFieldName = "StartDate"
ganttControl1.SplitTaskMappings.DurationFieldName = "Duration"
ganttControl1.SplitTaskMappings.KeyFieldName = "UID"
Dim splitInfo As New List(Of TaskSplitInfo)()
splitInfo.Add(New TaskSplitInfo() With {.UID = "8", .StartDate = tasks(8).StartDate.Add(TimeSpan.FromHours(2)), .Duration = TimeSpan.FromHours(8)})
splitInfo.Add(New TaskSplitInfo() With {.UID = "9", .StartDate = tasks(9).StartDate.Add(TimeSpan.FromHours(5)), .Duration = TimeSpan.FromDays(1)})
splitInfo.Add(New TaskSplitInfo() With {.UID = "10", .StartDate = tasks(10).StartDate.Add(TimeSpan.FromHours(4)), .Duration = TimeSpan.FromHours(4)})
splitInfo.Add(New TaskSplitInfo() With {.UID = "10", .StartDate = tasks(10).StartDate.Add(TimeSpan.FromDays(2).Add(TimeSpan.FromHours(2))), .Duration = TimeSpan.FromHours(4)})
ganttControl1.SplitTaskSource = splitInfo
Public Class TaskSplitInfo
Public Property UID() As String
Public Property StartDate() As Date
Public Property Duration() As TimeSpan
End Class
See Also