TileControl.CustomContextButtonToolTip Event

Allows you to specify a tooltip shown when the mouse pointer hovers over a context button. This event is only raised for RatingContextButton and TrackBarContextButton objects.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[DXCategory("Events")]
public event TileContextButtonToolTipEventHandler CustomContextButtonToolTip

VB.NET

<DXCategory("Events")>
Public Event CustomContextButtonToolTip As TileContextButtonToolTipEventHandler

Event Data

The CustomContextButtonToolTip event's data class is DevExpress.XtraEditors.TileContextButtonToolTipEventArgs.

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.

Example

The following code sample illustrates how to assign different tooltips to each of the five rating grades.

C#

void tileControl1_CustomContextButtonToolTip(object sender, TileContextButtonToolTipEventArgs e) {
    if(e.Item.Name == "ratingContextButton1") {
        int rating = Convert.ToInt32(e.Value);
        switch(rating) {
            case 1: e.Text = "Very Bad"; break;
            case 2: e.Text = "Bad"; break;
            case 3: e.Text = "Average"; break;
            case 4: e.Text = "Good"; break;
            case 5: e.Text = "Excellent"; break;
            default: e.Text = String.Empty; break;
        }
    }
}

VB.NET

Imports System

Private Sub tileControl1_CustomContextButtonToolTip(ByVal sender As Object, ByVal e As TileContextButtonToolTipEventArgs)
    If e.Item.Name = "ratingContextButton1" Then
        Dim rating As Integer = CInt(e.Value)
        Select Case rating
            Case 1
                e.Text = "Very Bad"
            Case 2
                e.Text = "Bad"
            Case 3
                e.Text = "Average"
            Case 4
                e.Text = "Good"
            Case 5
                e.Text = "Excellent"
            Case Else
                e.Text = String.Empty
        End Select
    End If
End Sub