Skip to main content
All docs
V24.1

CustomizeHeatmapToolTipEventArgs.Text Property

Gets or sets the cell tooltip text.

Namespace: DevExpress.XtraCharts.Heatmap

Assembly: DevExpress.XtraCharts.v24.1.dll

NuGet Package: DevExpress.Charts

Declaration

public string Text { get; set; }

Property Value

Type Description
String

A string value that specifies the tooltip text.

Remarks

To use HTML tags to format Text, initialize the HeatmapControl.ToolTipController property with a ToolTipController object, and enable the controller’s ToolTipController.AllowHtmlText property.

Example

This example shows how to use the HeatmapControl.CustomizeHeatmapToolTip event to modify tooltip content based on the cell value for which the tooltip is shown.

A tooltip customized in the CustomizeHeatmapToolTip handler.

Follow the steps below to enable and customize tooltips:

The code below applies a custom format to tooltip text if a heatmap cell value is more than the specified value:

const int ThresholdValue = 50;

public Form1() {
    InitializeComponent();
    // ...
    heatmap.ToolTipEnabled = true;
    heatmap.ToolTipController = new DevExpress.Utils.ToolTipController { AllowHtmlText = true };
    heatmap.CustomizeHeatmapToolTip += OnHeatmapCustomizeHeatmapToolTip;
}

private void OnHeatmapCustomizeHeatmapToolTip(object sender, CustomizeHeatmapToolTipEventArgs e) {
    double cellValue = (double)e.HeatmapCell.ColorValue;
    if (cellValue > ThresholdValue) {
        e.Title = "Sale Info";
        e.Text = $"Total: <color=green>${cellValue}K</color>";
    }
}
See Also