RibbonCheckBox.ToolTipDescription Property

Reference

Definition

Namespace:: System.Windows.Controls.Ribbon

Assembly:: System.Windows.Controls.Ribbon.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets the descriptive text that is displayed in the ToolTip for this control.

public:
 property System::String ^ ToolTipDescription { System::String ^ get(); void set(System::String ^ value); };

public string ToolTipDescription { get; set; }

member this.ToolTipDescription : string with get, set

Public Property ToolTipDescription As String

Property Value

String

The descriptive text to display in the ToolTip. The registered default is null. For more information about what can influence the value, see Dependency Property Value Precedence.

Examples

The following example shows the markup used to create the enhanced ToolTip.

Enhanced ToolTip

XAML

<ribbon:RibbonCheckBox Label="Ribbon Control"
                SmallImageSource="Images/Lightbulb16.png" 
                LargeImageSource="Images/Lightbulb32.png"
                KeyTip="N"
                ToolTipTitle="Command Name (Ctrl+N)" 
                ToolTipDescription="All ribbon commands should have enhanced tooltips to give the command name, shortcut key, description, and optional supplemental information."
                ToolTipImageSource="Images/Suggestion32.png"
                ToolTipFooterTitle="Press F1 for Help" 
                ToolTipFooterDescription="When practical, completely describe the command using a concise description. Link to Help only if further explanation is really necessary."
                ToolTipFooterImageSource="Images/Help16.png" />

Remarks

Warning

Each ribbon control inherits a FrameworkElement.ToolTip property. If the FrameworkElement.ToolTip property is set, the ribbon's enhanced ToolTip will not be shown; the standard ToolTip will be shown instead.

Dependency Property Information

Item	Value
Identifier field	ToolTipDescriptionProperty
Metadata properties set to `true`	None

Applies to

Product	Versions
.NET Framework	4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop	3.0, 3.1, 5, 6, 7, 8, 9, 10

Share via