GanttChartMappings.TextFieldName Property
Gets or sets the data source field (of the String type) that contains the caption displayed next to a task in the chart area.
Namespace: DevExpress.XtraGantt
Assembly: DevExpress.XtraGantt.v24.1.dll
NuGet Package: DevExpress.Win.Gantt
Declaration
[DefaultValue("")]
[DXCategory("Mappings")]
[XtraSerializableProperty]
public string TextFieldName { get; set; }Property Value
| Type | Default | Description |
|---|---|---|
| String | String.Empty | The data source field that contains a task’s caption. |
Remarks
The GanttControl.ChartMappings property provides access to data fields mapped to task properties that specify how a task is displayed in the chart area. The TextFieldName property specifies the data field that contains task captions.
The caption is displayed next to the task in the chart area. To obtain a task’s caption in code, you can use the GetText(GanttControlNode), GetText(Int32), and GetText() methods.
You can also handle the CustomTaskDisplayText event, which fires before a task is displayed, to specify a caption dynamically.
A task’s caption can also be displayed in interaction tooltips. You can use the InteractionTooltipTextFieldName property to specify the data field that contains task captions for tooltips. To obtain a task’s tooltip caption in code, use the GetTooltipText(Int32) method.
Related GitHub Examples
The following code snippet (auto-collected from DevExpress Examples) contains a reference to the TextFieldName property.
Note
The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.