RibbonCheckBox.ToolTipImageSource Property

Article
02/04/2013

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

Namespace: Microsoft.Windows.Controls.Ribbon
Assembly: RibbonControlsLibrary (in RibbonControlsLibrary.dll)

Syntax

'Declaration
Public Property ToolTipImageSource As ImageSource

public ImageSource ToolTipImageSource { get; set; }

public:
property ImageSource^ ToolTipImageSource {
    ImageSource^ get ();
    void set (ImageSource^ value);
}

member ToolTipImageSource : ImageSource with get, set

function get ToolTipImageSource () : ImageSource
function set ToolTipImageSource (value : ImageSource)

Property Value

Type: System.Windows.Media.ImageSource
The image to display in the ToolTip. The registered default is nulla null reference (Nothing in Visual Basic). For more information about what can influence the value, see Dependency Property Value Precedence.

Dependency Property Information

Identifier field	ToolTipImageSourceProperty
Metadata properties set to true	None

Remarks

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

Examples

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

Enhanced ToolTip

<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" />

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via