Back to all docs
API Reference / Telerik.Windows.Controls / RadToolTipService
New to Telerik UI for WPF? Start a free 30-day trial

RadToolTipService

Class

The RadToolTipService class provides a comprehensive service for managing tooltips in a WPF application. It enables the user to customize tooltip behavior through various properties and events, such as show and hide delays, position offsets, and tooltip content. This service supports the attachment of events for tooltip opening and closing, and facilitates dynamic updates to tooltips as the user interacts with UI elements. Furthermore, it manages the display of tooltips based on user actions (like mouse movement) and conditions, allowing for an enhanced user experience through rich tooltip customization.

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.dll

Syntax:
C#
public static class RadToolTipService

Inheritance: objectRadToolTipService

Fields

BetweenShowDelayProperty

DependencyProperty

Identifies the BetweenShowDelay dependency property.

C#
public static readonly DependencyProperty BetweenShowDelayProperty

HorizontalOffsetProperty

DependencyProperty

Identifies the HorizontalOffset dependency property.

C#
public static readonly DependencyProperty HorizontalOffsetProperty

InitialShowDelayProperty

DependencyProperty

Identifies the InitialShowDelay dependency property.

C#
public static readonly DependencyProperty InitialShowDelayProperty

IsEnabledProperty

DependencyProperty

Identifies the IsEnabled dependency property.

C#
public static readonly DependencyProperty IsEnabledProperty

IsOpenProperty

DependencyProperty

Identifies the IsOpen dependency property.

C#
public static readonly DependencyProperty IsOpenProperty

PlacementProperty

DependencyProperty

Identifies the Placement dependency property.

C#
public static readonly DependencyProperty PlacementProperty

PlacementRectangleProperty

DependencyProperty

Identifies the PlacementRectangle dependency property.

C#
public static readonly DependencyProperty PlacementRectangleProperty

PlacementTargetProperty

DependencyProperty

Identifies the PlacementTarget dependency property.

C#
public static readonly DependencyProperty PlacementTargetProperty

ShowDurationProperty

DependencyProperty

Identifies the ShowDuration dependency property.

C#
public static readonly DependencyProperty ShowDurationProperty

ToolTipClosingEvent

RoutedEvent

Identifies the ToolTipClosing routed event.

C#
public static readonly RoutedEvent ToolTipClosingEvent

ToolTipContentProperty

DependencyProperty

Identifies the ToolTipContent dependency property.

C#
public static readonly DependencyProperty ToolTipContentProperty

ToolTipContentTemplateProperty

DependencyProperty

Identifies the ToolTipContentTemplate dependency property.

C#
public static readonly DependencyProperty ToolTipContentTemplateProperty

ToolTipOpeningEvent

RoutedEvent

Identifies the ToolTipOpening routed event.

C#
public static readonly RoutedEvent ToolTipOpeningEvent

VerticalOffsetProperty

DependencyProperty

Identifies the VerticalOffset dependency property.

C#
public static readonly DependencyProperty VerticalOffsetProperty

Methods

AddToolTipClosingHandler(DependencyObject, RoutedEventHandler)

Adds handler for the ToolTipClosing event.

C#
public static void AddToolTipClosingHandler(DependencyObject target, RoutedEventHandler handler)
Parameters:targetDependencyObject

The target.

handlerRoutedEventHandler

The handler.

AddToolTipOpeningHandler(DependencyObject, RoutedEventHandler)

Adds handler for the ToolTipOpening event.

C#
public static void AddToolTipOpeningHandler(DependencyObject target, RoutedEventHandler handler)
Parameters:targetDependencyObject

The target.

handlerRoutedEventHandler

The handler.

GetBetweenShowDelay(DependencyObject)

Gets the maximum time between the display of two tooltips where the second tooltip appears without a delay.

C#
public static int GetBetweenShowDelay(DependencyObject element)
Parameters:elementDependencyObject

The element.

Returns:

int

GetHorizontalOffset(DependencyObject)

Gets the offset from the left of the area that is specified for the tooltip by the PlacementRectangle and PlacementTarget properties.

C#
public static double GetHorizontalOffset(DependencyObject element)
Parameters:elementDependencyObject

The element.

Returns:

double

GetInitialShowDelay(DependencyObject)

Gets the length of time before a tooltip opens.

C#
public static int GetInitialShowDelay(DependencyObject element)
Parameters:elementDependencyObject

The element.

Returns:

int

GetIsEnabled(DependencyObject)

Gets whether a tooltip appears.

C#
public static bool GetIsEnabled(DependencyObject element)
Parameters:elementDependencyObject

The element.

Returns:

bool

GetIsOpen(DependencyObject)

Gets whether a tooltip is currently visible.

C#
public static bool GetIsOpen(DependencyObject element)
Parameters:elementDependencyObject

The element.

Returns:

bool

GetPlacement(DependencyObject)

PlacementMode

Gets the orientation of the tooltip when it opens, and specifies how the tooltip behaves when it overlaps screen boundaries.

C#
public static PlacementMode GetPlacement(DependencyObject element)
Parameters:elementDependencyObject

The element.

Returns:

PlacementMode

GetPlacementRectangle(DependencyObject)

Rect

Gets the rectangular area relative to which the tooltip is positioned.

C#
public static Rect GetPlacementRectangle(DependencyObject element)
Parameters:elementDependencyObject

The element.

Returns:

Rect

GetPlacementTarget(DependencyObject)

UIElement

Gets the object relative to which the tooltip is positioned.

C#
public static UIElement GetPlacementTarget(DependencyObject element)
Parameters:elementDependencyObject

The element.

Returns:

UIElement

GetShowDuration(DependencyObject)

Gets the amount of time that a tooltip remains visible.

C#
public static int GetShowDuration(DependencyObject element)
Parameters:elementDependencyObject

The element.

Returns:

int

GetToolTipContent(DependencyObject)

Gets the content of the ToolTip.

C#
public static object GetToolTipContent(DependencyObject element)
Parameters:elementDependencyObject

The element.

Returns:

object

GetToolTipContentTemplate(DependencyObject)

DataTemplate

Gets the ToolTip content template.

C#
public static DataTemplate GetToolTipContentTemplate(DependencyObject element)
Parameters:elementDependencyObject

The element.

Returns:

DataTemplate

GetVerticalOffset(DependencyObject)

Gets the distance from the top of the area that is specified for the tooltip by the PlacementRectangle and PlacementTarget properties.

C#
public static double GetVerticalOffset(DependencyObject element)
Parameters:elementDependencyObject

The element.

Returns:

double

HideTooltip(FrameworkElement)

Hides the tooltip.

C#
public static void HideTooltip(FrameworkElement owner)
Parameters:ownerFrameworkElement

The owner of the tooltip.

RemoveToolTipClosingHandler(DependencyObject, RoutedEventHandler)

Removes handler for the ToolTipClosing event.

C#
public static void RemoveToolTipClosingHandler(DependencyObject target, RoutedEventHandler handler)
Parameters:targetDependencyObject

The target.

handlerRoutedEventHandler

The handler.

RemoveToolTipOpeningHandler(DependencyObject, RoutedEventHandler)

Removes handler for the ToolTipOpening event.

C#
public static void RemoveToolTipOpeningHandler(DependencyObject target, RoutedEventHandler handler)
Parameters:targetDependencyObject

The target.

handlerRoutedEventHandler

The handler.

SetBetweenShowDelay(DependencyObject, int)

Sets the maximum time between the display of two tooltips where the second tooltip appears without a delay.

C#
public static void SetBetweenShowDelay(DependencyObject element, int value)
Parameters:elementDependencyObject

The element.

valueint

The value.

SetHorizontalOffset(DependencyObject, double)

Sets the offset from the left of the area that is specified for the tooltip by the PlacementRectangle and PlacementTarget properties.

C#
public static void SetHorizontalOffset(DependencyObject element, double value)
Parameters:elementDependencyObject

The element.

valuedouble

The value.

SetInitialShowDelay(DependencyObject, int)

Sets the length of time before a tooltip opens.

C#
public static void SetInitialShowDelay(DependencyObject element, int value)
Parameters:elementDependencyObject

The element.

valueint

The value.

SetIsEnabled(DependencyObject, bool)

Sets whether a tooltip appears.

C#
public static void SetIsEnabled(DependencyObject element, bool value)
Parameters:elementDependencyObject

The element.

valuebool

The value.

SetPlacement(DependencyObject, PlacementMode)

Sets the orientation of the tooltip when it opens, and specifies how the tooltip behaves when it overlaps screen boundaries.

C#
public static void SetPlacement(DependencyObject element, PlacementMode value)
Parameters:elementDependencyObject

The element.

valuePlacementMode

The value.

SetPlacementRectangle(DependencyObject, Rect)

Sets the rectangular area relative to which the tooltip is positioned.

C#
public static void SetPlacementRectangle(DependencyObject element, Rect value)
Parameters:elementDependencyObject

The element.

valueRect

The value.

SetPlacementTarget(DependencyObject, UIElement)

Sets the object relative to which the tooltip is positioned.

C#
public static void SetPlacementTarget(DependencyObject element, UIElement value)
Parameters:elementDependencyObject

The element.

valueUIElement

The value.

SetShowDuration(DependencyObject, int)

Sets the amount of time that a tooltip remains visible.

C#
public static void SetShowDuration(DependencyObject element, int value)
Parameters:elementDependencyObject

The element.

valueint

The value.

SetToolTipContent(DependencyObject, object)

Sets the content of the ToolTip.

C#
public static void SetToolTipContent(DependencyObject element, object value)
Parameters:elementDependencyObject

The element.

valueobject

The value.

SetToolTipContentTemplate(DependencyObject, DataTemplate)

Sets the ToolTip content template.

C#
public static void SetToolTipContentTemplate(DependencyObject element, DataTemplate value)
Parameters:elementDependencyObject

The element.

valueDataTemplate

The value.

SetVerticalOffset(DependencyObject, double)

Sets the distance from the top of the area that is specified for the tooltip by the PlacementRectangle and PlacementTarget properties.

C#
public static void SetVerticalOffset(DependencyObject element, double value)
Parameters:elementDependencyObject

The element.

valuedouble

The value.

In this article
DefinitionFieldsBetweenShowDelayPropertyHorizontalOffsetPropertyInitialShowDelayPropertyIsEnabledPropertyIsOpenPropertyPlacementPropertyPlacementRectanglePropertyPlacementTargetPropertyShowDurationPropertyToolTipClosingEventToolTipContentPropertyToolTipContentTemplatePropertyToolTipOpeningEventVerticalOffsetPropertyMethodsAddToolTipClosingHandler(DependencyObject, RoutedEventHandler)AddToolTipOpeningHandler(DependencyObject, RoutedEventHandler)GetBetweenShowDelay(DependencyObject)GetHorizontalOffset(DependencyObject)GetInitialShowDelay(DependencyObject)GetIsEnabled(DependencyObject)GetIsOpen(DependencyObject)GetPlacement(DependencyObject)GetPlacementRectangle(DependencyObject)GetPlacementTarget(DependencyObject)GetShowDuration(DependencyObject)GetToolTipContent(DependencyObject)GetToolTipContentTemplate(DependencyObject)GetVerticalOffset(DependencyObject)HideTooltip(FrameworkElement)RemoveToolTipClosingHandler(DependencyObject, RoutedEventHandler)RemoveToolTipOpeningHandler(DependencyObject, RoutedEventHandler)SetBetweenShowDelay(DependencyObject, int)SetHorizontalOffset(DependencyObject, double)SetInitialShowDelay(DependencyObject, int)SetIsEnabled(DependencyObject, bool)SetPlacement(DependencyObject, PlacementMode)SetPlacementRectangle(DependencyObject, Rect)SetPlacementTarget(DependencyObject, UIElement)SetShowDuration(DependencyObject, int)SetToolTipContent(DependencyObject, object)SetToolTipContentTemplate(DependencyObject, DataTemplate)SetVerticalOffset(DependencyObject, double)
Not finding the help you need?
Contact Support