BootstrapUIWidgetTooltipSettings.OnClientCustomizeTooltip Property

Specifies a client callback function used to customize the tooltip.

Namespace: DevExpress.Web.Bootstrap

Assembly: DevExpress.Web.Bootstrap.v18.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 the text for the tooltip to display.

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

This property should be assigned a function returning a specific object. The following fields can be specified in this object.

• color - Specifies the color of a tooltip.
• text - Specifies the text displayed by a tooltip.

• html - Specifies the HTML markup displayed by a tooltip.

  Note

  If you are going to use external resources (for example, images) in the markup, specify the size of the area they will occupy beforehand.

• fontColor - Specifies the color of the text displayed by a tooltip.
• borderColor - Specifies the color of the tooltip border.

For more information on this property, refer to the customizeTooltip article.