ToolTipTitle Property (SharedProps)

Gets or sets the text displayed for the tooltip title of the ToolBase when the mouse cursor moves over it.

Syntax

Visual Basic

public string ToolTipTitle {get; set;}

C#

'Declaration
 
Public Property ToolTipTitle As String

 

Property Value

The text displayed for the tooltip title of the ToolBase when the mouse cursor moves over it.

Exceptions

Exception	Description
System.NotSupportedException	The property is modified at design-time for a tool in an UltraToolbarsManager defined on a base Form or UserControl. Inherited tools must be modified at run-time or at design-time through the designer of the Form or UserControl they were created on.

Remarks

Note: When the tooltip is displaying formatted text (see ToolTipTextFormatted and UltraToolbarsManager.ToolTipDisplayStyle), and UltraToolbarsManager.ShowShortcutsInToolTips is turned on, the shortcut will always be displayed in the tooltip title - even when no other ToolTipTitle text has been specified.

Example

The following code demonstrates the ToolTipTitle, ToolTipTextFormatted, and ToolTipDisplayStyle properties.

Imports Infragistics.Win

' This will tell all tools on the Toolbar to use Formatted tooltips only. This means they
' will use the tool.SharedProps.ToolTipTextFormatted, not tool.SharedProps.ToolTipTextFormatted
Me.UltraToolbarsManager1.ToolTipDisplayStyle = UltraWinToolbars.ToolTipDisplayStyle.Formatted

' Set a title for the tooltip. This applies regardless of the ToolTipDisplayStyle
Me.UltraToolbarsManager1.Tools("ButtonTool1").SharedProps.ToolTipTitle = "This is the tooltip title"

' Set the regular ToolTipText. This will only appear when ultraToolbarsManager1.ToolTipDisplayStyle 
' is set to Standard or if it is set to Default and the ToolTipTextFormatted is blank.
Me.UltraToolbarsManager1.Tools("ButtonTool1").SharedProps.ToolTipText = "This is an unformatted tooltip"

' Set the ToolTipTextFormatted. This will only appear when ultraToolbarsManager1.ToolTipDisplayStyle 
' is set to Formatted or Default.
Me.UltraToolbarsManager1.Tools("ButtonTool1").SharedProps.ToolTipTextFormatted = "This is a <span style=""font-weight:bold;"">formatted</span>&edsp;<span style=""color:Red;"">tooltip</span>."

'Declaration
 
Public Property ToolTipTitle As String

 

using Infragistics.Win;

// This will tell all tools on the Toolbar to use Formatted tooltips only. This means they
// will use the tool.SharedProps.ToolTipTextFormatted, not tool.SharedProps.ToolTipTextFormatted
this.ultraToolbarsManager1.ToolTipDisplayStyle = Infragistics.Win.UltraWinToolbars.ToolTipDisplayStyle.Formatted;

// Set a title for the tooltip. This applies regardless of the ToolTipDisplayStyle
this.ultraToolbarsManager1.Tools["ButtonTool1"].SharedProps.ToolTipTitle = "This is the tooltip title";

// Set the regular ToolTipText. This will only appear when ultraToolbarsManager1.ToolTipDisplayStyle 
// is set to Standard or if it is set to Default and the ToolTipTextFormatted is blank.
this.ultraToolbarsManager1.Tools["ButtonTool1"].SharedProps.ToolTipText = "This is an unformatted tooltip";

// Set the ToolTipTextFormatted. This will only appear when ultraToolbarsManager1.ToolTipDisplayStyle 
// is set to Formatted or Default.
this.ultraToolbarsManager1.Tools["ButtonTool1"].SharedProps.ToolTipTextFormatted = "This is a <span style=\"font-weight:bold;\">formatted</span>&edsp;<span style=\"color:Red;\">tooltip</span>.";

'Declaration
 
Public Property ToolTipTitle As String

 

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2