SankeyDiagramControl.CustomizeLinkToolTip Event

Occurs before a tooltip is displayed for a link and allows you to format tooltip content.

Namespace: DevExpress.XtraCharts.Sankey

Assembly: DevExpress.XtraCharts.v24.1.UI.dll

NuGet Package: DevExpress.Win.Charts

Declaration

C#

public event CustomizeSankeyLinkToolTipEventHandler CustomizeLinkToolTip

VB.NET

Public Event CustomizeLinkToolTip As CustomizeSankeyLinkToolTipEventHandler

Event Data

The CustomizeLinkToolTip event's data class is CustomizeSankeyLinkToolTipEventArgs. The following properties provide information specific to this event:

Property	Description
Content	Specifies the tooltip’s content. Inherited from CustomizeSankeyToolTipEventArgs.
Link	Returns the link whose tooltip is customized.
Title	Specifies the tooltip’s title. Inherited from CustomizeSankeyToolTipEventArgs.

Remarks

Handle the CustomizeNodeToolTip event to customize tooltips for nodes.

Example

To format tooltip text for links, handle the CustomizeLinkToolTip event and specify the CustomizeSankeyToolTipEventArgs.Title and CustomizeSankeyToolTipEventArgs.Content properties.

C#

private void Form1_Load(object sender, EventArgs e) {
    sankeyDiagramControl1.ToolTipOptions.LinkToolTipEnabled = DevExpress.Utils.DefaultBoolean.True;
    sankeyDiagramControl1.ToolTipController = new DevExpress.Utils.ToolTipController { 
        ToolTipType = DevExpress.Utils.ToolTipType.Flyout, 
        AllowHtmlText = true 
    };
    sankeyDiagramControl1.CustomizeLinkToolTip += OnCustomizeLinkToolTip;
}

private void OnCustomizeLinkToolTip(object sender, CustomizeSankeyLinkToolTipEventArgs e) {
    e.Title = $"{e.Link.SourceNode.Tag} → {e.Link.TargetNode.Tag}";
    e.Content = $"{e.Link.TotalWeight}";
}

VB.NET

Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs)
    sankeyDiagramControl1.ToolTipOptions.LinkToolTipEnabled = DevExpress.Utils.DefaultBoolean.[True]
    sankeyDiagramControl1.ToolTipController = New DevExpress.Utils.ToolTipController With {
        .ToolTipType = DevExpress.Utils.ToolTipType.Flyout,
        .AllowHtmlText = True
    }
    sankeyDiagramControl1.CustomizeLinkToolTip += AddressOf OnCustomizeLinkToolTip
End Sub


Private Sub OnCustomizeLinkToolTip(ByVal sender As Object, ByVal e As CustomizeSankeyLinkToolTipEventArgs)
    e.Title = $"{e.Link.SourceNode.Tag} → {e.Link.TargetNode.Tag}"
    e.Content = $"{e.Link.TotalWeight}"
End Sub