Back to Devexpress

ToolTipControllerShowEventArgs.ToolTip Property

windowsforms-devexpress-dot-utils-dot-tooltipcontrollershoweventargs-327cd4e5.md

latest5.2 KB
Original Source

ToolTipControllerShowEventArgs.ToolTip Property

Gets or sets the text for the regular tooltip.

Namespace : DevExpress.Utils

Assembly : DevExpress.Utils.v25.2.dll

NuGet Packages : DevExpress.Utils, DevExpress.Wpf.Core

Declaration

csharp
public string ToolTip { get; set; }
vb
Public Property ToolTip As String

Property Value

TypeDescription
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. 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.

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.

winforms-dashboard-custom-items-extension/CS/CustomItemExtension/CustomItems/SankeyChart/SankeyItemControlProvider.cs#L69

csharp
if(dashboardItem.Metadata.Weight == null)
    e.ToolTip = string.Empty;
else if(e.SelectedObject is SankeyLink) {

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

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

winforms-lookup-show-custom-tooltips/CS/LookUpEditWithHints/Form1.cs#L39

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

winforms-dashboard-custom-items-extension/VB/CustomItemExtension/CustomItems/SankeyChart/SankeyItemControlProvider.vb#L80

vb
If dashboardItem.Metadata.Weight Is Nothing Then
    e.ToolTip = String.Empty
ElseIf TypeOf e.SelectedObject Is SankeyLink Then

winforms-scheduler-display-custom-tooltips/VB/Form1.vb#L49

vb
e.Title = "Resource"
    e.ToolTip = res.Caption
End If

show-super-tooltip-for-disabled-control/VB/ToolTipController/Form1.vb#L73

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

winforms-lookup-show-custom-tooltips/VB/LookUpEditWithHints/Form1.vb#L33

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

See Also

ToolTipControllerShowEventArgs Class

ToolTipControllerShowEventArgs Members

DevExpress.Utils Namespace