ToolTipControllerShowEventArgs.ToolTip Property

Gets or sets the text for the regular tooltip.

Namespace: DevExpress.Utils

Assembly: DevExpress.Utils.v18.2.dll

Declaration

C#

public string ToolTip { get; set; }

VB.NET

Public Property ToolTip As String

Property Value

Type	Description
String	The string that is the text to display in the regular tooltip.

Remarks

The ToolTip property allows you to specify the text for the regular tooltip . The size of the tooltip window will be calculated based on the text’s length and font (according to the ToolTipController.Style style). To learn about regular tooltips and SuperToolTips, see ToolTipControllerShowEventArgs.ToolTipType.

You can also provide a title and image for a regular tooltip via the ToolTipControllerShowEventArgs.ToolTipType and ToolTipControllerShowEventArgs.ToolTipImage properties.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references 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#

show-super-tooltip-for-disabled-controls-e521/CS/ToolTipController/Form1.cs#L53

showArgs.ToolTipType = DevExpress.Utils.ToolTipType.SuperTip;
showArgs.ToolTip = string.Format("Here is the super tool tip for button: {0}", ActiveButton.Text);
ToolTipController.ShowHint(showArgs);

how-to-provide-the-capability-to-show-tooltips-for-lookupedit-items-e3040/CS/LookUpEditWithHints/Form1.cs#L39

    ToolTipControllerShowEventArgs ee = e as ToolTipControllerShowEventArgs;
    ee.ToolTip += " + custom tool tip also can be added";
}

gridview-how-to-show-a-tooltip-when-scrolling-using-a-thumb-e2165/CS/MyXtraGrid/MyGridView.cs#L40

ToolTipControllerShowEventArgs tool = GridControl.ToolTipController.CreateShowArgs();
tool.ToolTip = GetToolTipText();
tool.SelectedObject = this;

how-to-show-a-tooltip-for-time-cells-in-a-scheduler-view-e414/CS/SchedulerViewCellToolTip/Form1.cs#L18

    if (cell != null)
        e.ToolTip = cell.Interval.ToString();
}

how-to-customize-visible-time-e3202/CS/Form1.cs#L24

private void rangeTrackBarControl1_BeforeShowValueToolTip(object sender, DevExpress.XtraEditors.TrackBarValueToolTipEventArgs e) {
    e.ShowArgs.ToolTip = string.Format("Interval = [{0}; {1}]", StartTimeOffset, EndTimeOffset);
}

VB.NET

show-super-tooltip-for-disabled-controls-e521/VB/ToolTipController/Form1.vb#L71

showArgs.ToolTipType = DevExpress.Utils.ToolTipType.SuperTip
showArgs.ToolTip = String.Format("Here is the super tool tip for button: {0}", ActiveButton.Text)
ToolTipController.ShowHint(showArgs)

how-to-provide-the-capability-to-show-tooltips-for-lookupedit-items-e3040/VB/LookUpEditWithHints/Form1.vb#L36

    Dim ee As ToolTipControllerShowEventArgs = TryCast(e, ToolTipControllerShowEventArgs)
    ee.ToolTip &= " + custom tool tip also can be added"
End Sub

gridview-how-to-show-a-tooltip-when-scrolling-using-a-thumb-e2165/VB/MyXtraGrid/MyGridView.vb#L46

Dim tool As ToolTipControllerShowEventArgs = GridControl.ToolTipController.CreateShowArgs()
tool.ToolTip = GetToolTipText()
tool.SelectedObject = Me

how-to-show-a-tooltip-for-time-cells-in-a-scheduler-view-e414/VB/SchedulerViewCellToolTip/Form1.vb#L20

If cell IsNot Nothing Then
    e.ToolTip = cell.Interval.ToString()
End If

how-to-customize-visible-time-e3202/VB/Form1.vb#L34

Private Sub rangeTrackBarControl1_BeforeShowValueToolTip(ByVal sender As Object, ByVal e As DevExpress.XtraEditors.TrackBarValueToolTipEventArgs) Handles rangeTrackBarControl1.BeforeShowValueToolTip
    e.ShowArgs.ToolTip = String.Format("Interval = [{0}; {1}]", StartTimeOffset, EndTimeOffset)
End Sub