Back to Devexpress

GanttControl.GetText(GanttControlNode) Method

windowsforms-devexpress-dot-xtragantt-dot-ganttcontrol-dot-gettext-x28-devexpress-dot-xtragantt-dot-ganttcontrolnode-x29.md

latest3.3 KB
Original Source

GanttControl.GetText(GanttControlNode) Method

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

Namespace : DevExpress.XtraGantt

Assembly : DevExpress.XtraGantt.v25.2.dll

NuGet Package : DevExpress.Win.Gantt

Declaration

csharp
public string GetText(
    GanttControlNode node
)
vb
Public Function GetText(
    node As GanttControlNode
) As String

Parameters

NameTypeDescription
nodeGanttControlNode

An object that specifies a task (node).

|

Returns

TypeDescription
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.

See Also

Tasks, Summaries, and Milestones

Obtaining and Setting Cell Values

GetText(Int32)

GetText()

CustomTaskDisplayText

TextFieldName

InteractionTooltipTextFieldName

GanttControl Class

GanttControl Members

DevExpress.XtraGantt Namespace