RatingControl.BeforeShowToolTip Event

Raises before the rating tooltip is shown and allows you to show your custom text.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v19.2.dll

Declaration

C#

[DXCategory("Events")]
public event RatingToolTipEventHandler BeforeShowToolTip

VB.NET

<DXCategory("Events")>
Public Event BeforeShowToolTip As RatingToolTipEventHandler

Event Data

The BeforeShowToolTip event's data class is DevExpress.XtraEditors.Repository.RatingToolTipEventArgs.

Remarks

The BeforeShowToolTip event fires after an end-user hovered a rating item within this RatingControl, just before the tooltip is shown. By default, the tooltip text displays the hovered item’s value. Handle the BeforeShowToolTip event and specify the e.Text property to set the desired hint for the target rating item. To check which rating item is currently hovered, read the e.Value property.

Below is sample code that sets custom hints for the rating control with the RepositoryItemRatingControl.FillPrecision set to Full.

C#

private void ratingControlSample_Properties_BeforeShowToolTip(object sender, Repository.RatingToolTipEventArgs e) {
    switch(Decimal.ToInt32(e.Value)) {
        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;
    }
}

VB.NET

Private Sub ratingControlSample_Properties_BeforeShowToolTip(ByVal sender As Object, ByVal e As Repository.RatingToolTipEventArgs)
    Select Case Decimal.ToInt32(e.Value)
        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"
    End Select
End Sub

The result is shown in the following animation.