BootstrapUIWidgetTooltipSettings.OnClientCustomizeTooltip Property

Specifies a client callback function used to customize the tooltip.

Namespace: DevExpress.Web.Bootstrap

Assembly: DevExpress.Web.Bootstrap.v19.2.dll

Declaration

C#

[DefaultValue("")]
public string OnClientCustomizeTooltip { get; set; }

VB.NET

<DefaultValue("")>
Public Property OnClientCustomizeTooltip As String

Property Value

Type	Default	Description
String	String.Empty	A string that represents either the name of a JavaScript function or the entire JavaScript function code that returns an object that specifies the tooltip’s text/markup, and appearance settings.

Property Paths

You can access this nested property as listed below:

Object Type	Path to OnClientCustomizeTooltip
BootstrapChart	.SettingsToolTip.OnClientCustomizeTooltip
BootstrapChartBase	.SettingsToolTip.OnClientCustomizeTooltip
BootstrapCoordinateSystemChart	.SettingsToolTip.OnClientCustomizeTooltip
BootstrapPieChart	.SettingsToolTip.OnClientCustomizeTooltip
BootstrapPolarChart	.SettingsToolTip.OnClientCustomizeTooltip
BootstrapSparkline	.SettingsToolTip.OnClientCustomizeTooltip

Remarks

The function returned by OnClientCustomizeTooltip accepts an object with properties that depend on the chart type. For more information on this object’s properties, refer to the customizeTooltip article.

chart.OnClientCustomizeTooltip = @"function(arg) {
    return {
        text: arg.argumentText + ""<br/>"" + arg.valueText
    };
}";