ContextItem.ToolTip Property

Gets or sets the text in a regular tooltip shown when the mouse pointer hovers over the button.

Namespace: DevExpress.Utils

Assembly: DevExpress.Utils.v24.2.dll

Declaration

C#

[DefaultValue("")]
[DXCategory("ToolTip")]
public virtual string ToolTip { get; set; }

VB.NET

<DXCategory("ToolTip")>
<DefaultValue("")>
Public Overridable Property ToolTip As String

Property Value

Type	Default	Description
String	String.Empty	A String value that specifies the text in a regular tooltip shown when the mouse pointer hovers over the button.

Remarks

Use a context button’s SuperTip property to assign a super tooltip to the button. To assign a regular tooltip, use the following properties:

• ToolTip — gets or sets the tooltip text.
• ToolTipTitle — gets or sets the title displayed above the text.
• ToolTipIconType — gets or sets the icon that indicates whether the tooltip contains an error, warning, question, or other information.

See the following topic for more information about regular and super tooltips: Hints and Tooltips.

Rating Scale and Track Bar

The RatingContextButton and TrackBarContextButton show the current rating and track value in the default tooltips.

You can handle the owner control’s CustomContextButtonToolTip or the button’s CustomToolTip event to specify custom tooltips. Use the Value event argument to obtain the current value and the Text event argument to specify the tooltip text.

Note

The owner control’s CustomContextButtonToolTip event fires after the button’s CustomToolTip event and overrides its tooltips. Also note that these events do not fire if a super or regular tooltip is assigned to the button.

Disable Tooltips

You can also disable the owner control’s ShowToolTips option to hide tooltips. The button’s ShowToolTips property overrides this option for an individual button.

C#

pictureEdit1.Properties.ContextButtonOptions.ShowToolTips = false;

VB.NET

pictureEdit1.Properties.ContextButtonOptions.ShowToolTips = False

Note

If a context button’s Enabled property is set to false, tooltips are not displayed regardless of the owner control’s ShowToolTips option or the button’s ShowToolTips property.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ToolTip property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-calendar-dateedit-cell-appearance-customization/CS/Calendar_CellStyleProvider/Form1.cs#L38

e.Item.Visibility = ContextItemVisibility.Visible;
e.Item.ToolTip = holidayText;
e.Item.ShowToolTips = true;

VB.NET

winforms-calendar-dateedit-cell-appearance-customization/VB/Calendar_CellStyleProvider/Form1.vb#L39

e.Item.Visibility = ContextItemVisibility.Visible
e.Item.ToolTip = holidayText
e.Item.ShowToolTips = True