GanttControl.GetText(GanttControlNode) Method

Returns the caption displayed next to the specified task (node) in the chart area.

Namespace: DevExpress.XtraGantt

Assembly: DevExpress.XtraGantt.v24.1.dll

NuGet Package: DevExpress.Win.Gantt

Declaration

C#

public string GetText(
    GanttControlNode node
)

VB.NET

Public Function GetText(
    node As GanttControlNode
) As String

Parameters

Name	Type	Description
node	GanttControlNode	An object that specifies a task (node).

Returns

Type	Description
String	A value that specifies a 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.