Get started for free
This topic has not yet been rated - Rate this topic

FrameworkElement.ToolTip Property

.NET Framework 4.5

Gets or sets the tool-tip object that is displayed for this element in the user interface (UI).

Namespace:  System.Windows
Assembly:  PresentationFramework (in PresentationFramework.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation
C#
C++
F#
VB
Copy 
[BindableAttribute(true)]
[LocalizabilityAttribute(LocalizationCategory.ToolTip)]
public Object ToolTip { get; set; }
XAML Property Element Usage
Copy 
<object>
  <object.ToolTip>
    <ToolTip .../>
  </object.ToolTip>
</object>
- or -
<object>
  <object.ToolTip>
    toolTipObjectContent
  </object.ToolTip>
</object>
XAML Attribute Usage
Copy 
<object ToolTip="toolTipContent"/>

XAML Values

toolTipContent

A string that becomes the display text for the ToolTip.

toolTipObjectContent

Some object, provided in object element form, that should be used as the content for the FrameworkElement . Typically this would be a FrameworkElement or some other element that creates layout compositing for the ToolTip, eventually containing text content within the compositing. In this usage, the ToolTip element is created implicitly from the parsed XAML, and the toolTipObjectContent content is set as its ContentControl.Content property.

<ToolTip .../>

See ToolTip.

Property Value

Type: System.Object
The tooltip object. See Remarks below for details on why this parameter is not strongly typed.

Identifier field

ToolTipProperty

Metadata properties set to true

None

If the value of this property is of type ToolTip, then that value is the tool-tip that will be used in the UI. If the value is of any other type, then that value will be used as the content for a ToolTip provided (constructed) by the system. For more information, see ToolTipService. The service class provides attached properties that can be used to further customize a ToolTip.

The following example creates a ToolTip in code and then sets the ToolTip property on a StatusBar control.

C#
VB
Copy 
private void MakeProgressBar(object sender, RoutedEventArgs e)
{
    sbar.Items.Clear();
    TextBlock txtb = new TextBlock();
    txtb.Text = "Progress of download.";
    sbar.Items.Add(txtb);
    ProgressBar progressbar = new ProgressBar();
    progressbar.Width = 100;
    progressbar.Height = 20;
    Duration duration = new Duration(TimeSpan.FromSeconds(5));
    DoubleAnimation doubleanimation =
                               new DoubleAnimation(100.0, duration);
    progressbar.BeginAnimation(ProgressBar.ValueProperty,
                               doubleanimation);
    ToolTip ttprogbar = new ToolTip();
    ttprogbar.Content = "Shows the progress of a download.";
    progressbar.ToolTip = (ttprogbar);
    sbar.Items.Add(progressbar);
}

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Did you find this helpful?
(1500 characters remaining)
© 2013 Microsoft. All rights reserved.