A newer version of this page is available. Switch to the current version.

BaseControl.ToolTip Property

Gets or sets a regular tooltip's content.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v19.1.dll

Declaration

[DXCategory("ToolTip")]
[DefaultValue("")]
public virtual string ToolTip { get; set; }
<DXCategory("ToolTip")>
<DefaultValue("")>
Public Overridable Property ToolTip As String

Property Value

Type Default Description
String

String.Empty

A string which specifies the text content of a regular tooltip.

Remarks

BaseControl descendants support regular tooltips and SuperToolTips. Use the ToolTip property to specify a regular tooltip's text content. The tooltip's title and icon can be specified via the BaseControl.ToolTipTitle and BaseControl.ToolTipIconType properties. The following image shows a sample regular tooltip:

BaseControl_ToolTipTitle

The BaseControl.SuperTip property allows you to assign a SuperToolTip to a control.

To temporarily disable tooltips, set the BaseControl.ShowToolTips property to false.

The BaseControl.ToolTipController property determines the ToolTipController which manages tooltips for the control. The type of tooltips displayed by controls is determined by the ToolTipController.ToolTipType property. See Tooltip Management, for more information.

It's possible to use HTML formatting in regular and SuperToolTips. To enable HTML formatting in regular tooltips, use the BaseControl.AllowHtmlTextInToolTip property. To enable HTML formatting in SuperToolTips, use the SuperToolTip.AllowHtmlText property. See HTML Text Formatting to learn more.

See Also