Class
RadToolTipService

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:

cs-api-definition

public static class RadToolTipService

Inheritance: objectRadToolTipService

Fields

BetweenShowDelayProperty

Identifies the BetweenShowDelay dependency property.

Declaration

cs-api-definition

public static readonly DependencyProperty BetweenShowDelayProperty

Field Value

DependencyProperty

HorizontalOffsetProperty

Identifies the HorizontalOffset dependency property.

Declaration

cs-api-definition

public static readonly DependencyProperty HorizontalOffsetProperty

Field Value

DependencyProperty

InitialShowDelayProperty

Identifies the InitialShowDelay dependency property.

Declaration

cs-api-definition

public static readonly DependencyProperty InitialShowDelayProperty

Field Value

DependencyProperty

IsEnabledProperty

Identifies the IsEnabled dependency property.

Declaration

cs-api-definition

public static readonly DependencyProperty IsEnabledProperty

Field Value

DependencyProperty

IsOpenProperty

Identifies the IsOpen dependency property.

Declaration

cs-api-definition

public static readonly DependencyProperty IsOpenProperty

Field Value

DependencyProperty

PlacementProperty

Identifies the Placement dependency property.

Declaration

cs-api-definition

public static readonly DependencyProperty PlacementProperty

Field Value

DependencyProperty

PlacementRectangleProperty

Identifies the PlacementRectangle dependency property.

Declaration

cs-api-definition

public static readonly DependencyProperty PlacementRectangleProperty

Field Value

DependencyProperty

PlacementTargetProperty

Identifies the PlacementTarget dependency property.

Declaration

cs-api-definition

public static readonly DependencyProperty PlacementTargetProperty

Field Value

DependencyProperty

ShowDurationProperty

Identifies the ShowDuration dependency property.

Declaration

cs-api-definition

public static readonly DependencyProperty ShowDurationProperty

Field Value

DependencyProperty

ToolTipClosingEvent

Identifies the ToolTipClosing routed event.

Declaration

cs-api-definition

public static readonly RoutedEvent ToolTipClosingEvent

Field Value

RoutedEvent

ToolTipContentProperty

Identifies the ToolTipContent dependency property.

Declaration

cs-api-definition

public static readonly DependencyProperty ToolTipContentProperty

Field Value

DependencyProperty

ToolTipContentTemplateProperty

Identifies the ToolTipContentTemplate dependency property.

Declaration

cs-api-definition

public static readonly DependencyProperty ToolTipContentTemplateProperty

Field Value

DependencyProperty

ToolTipOpeningEvent

Identifies the ToolTipOpening routed event.

Declaration

cs-api-definition

public static readonly RoutedEvent ToolTipOpeningEvent

Field Value

RoutedEvent

VerticalOffsetProperty

Identifies the VerticalOffset dependency property.

Declaration

cs-api-definition

public static readonly DependencyProperty VerticalOffsetProperty

Field Value

DependencyProperty

Methods

AddToolTipClosingHandler(DependencyObject, RoutedEventHandler)

Adds handler for the ToolTipClosing event.

Declaration

cs-api-definition

public static void AddToolTipClosingHandler(DependencyObject target, RoutedEventHandler handler)

Parameters

target

DependencyObject

The target.

handler

RoutedEventHandler

The handler.

AddToolTipOpeningHandler(DependencyObject, RoutedEventHandler)

Adds handler for the ToolTipOpening event.

Declaration

cs-api-definition

public static void AddToolTipOpeningHandler(DependencyObject target, RoutedEventHandler handler)

Parameters

target

DependencyObject

The target.

handler

RoutedEventHandler

The handler.

GetBetweenShowDelay(DependencyObject)

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

Declaration

cs-api-definition

public static int GetBetweenShowDelay(DependencyObject element)

Parameters

element

DependencyObject

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.

Declaration

cs-api-definition

public static double GetHorizontalOffset(DependencyObject element)

Parameters

element

DependencyObject

The element.

Returns

double

GetInitialShowDelay(DependencyObject)

Gets the length of time before a tooltip opens.

Declaration

cs-api-definition

public static int GetInitialShowDelay(DependencyObject element)

Parameters

element

DependencyObject

The element.

Returns

int

GetIsEnabled(DependencyObject)

Gets whether a tooltip appears.

Declaration

cs-api-definition

public static bool GetIsEnabled(DependencyObject element)

Parameters

element

DependencyObject

The element.

Returns

bool

GetIsOpen(DependencyObject)

Gets whether a tooltip is currently visible.

Declaration

cs-api-definition

public static bool GetIsOpen(DependencyObject element)

Parameters

element

DependencyObject

The element.

Returns

bool

GetPlacement(DependencyObject)

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

Declaration

cs-api-definition

public static PlacementMode GetPlacement(DependencyObject element)

Parameters

element

DependencyObject

The element.

Returns

PlacementMode

GetPlacementRectangle(DependencyObject)

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

Declaration

cs-api-definition

public static Rect GetPlacementRectangle(DependencyObject element)

Parameters

element

DependencyObject

The element.

Returns

Rect

GetPlacementTarget(DependencyObject)

Gets the object relative to which the tooltip is positioned.

Declaration

cs-api-definition

public static UIElement GetPlacementTarget(DependencyObject element)

Parameters

element

DependencyObject

The element.

Returns

UIElement

GetShowDuration(DependencyObject)

Gets the amount of time that a tooltip remains visible.

Declaration

cs-api-definition

public static int GetShowDuration(DependencyObject element)

Parameters

element

DependencyObject

The element.

Returns

int

GetToolTipContent(DependencyObject)

Gets the content of the ToolTip.

Declaration

cs-api-definition

public static object GetToolTipContent(DependencyObject element)

Parameters

element

DependencyObject

The element.

Returns

object

GetToolTipContentTemplate(DependencyObject)

Gets the ToolTip content template.

Declaration

cs-api-definition

public static DataTemplate GetToolTipContentTemplate(DependencyObject element)

Parameters

element

DependencyObject

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.

Declaration

cs-api-definition

public static double GetVerticalOffset(DependencyObject element)

Parameters

element

DependencyObject

The element.

Returns

double

HideTooltip(FrameworkElement)

Hides the tooltip.

Declaration

cs-api-definition

public static void HideTooltip(FrameworkElement owner)

Parameters

owner

FrameworkElement

The owner of the tooltip.

RemoveToolTipClosingHandler(DependencyObject, RoutedEventHandler)

Removes handler for the ToolTipClosing event.

Declaration

cs-api-definition

public static void RemoveToolTipClosingHandler(DependencyObject target, RoutedEventHandler handler)

Parameters

target

DependencyObject

The target.

handler

RoutedEventHandler

The handler.

RemoveToolTipOpeningHandler(DependencyObject, RoutedEventHandler)

Removes handler for the ToolTipOpening event.

Declaration

cs-api-definition

public static void RemoveToolTipOpeningHandler(DependencyObject target, RoutedEventHandler handler)

Parameters

target

DependencyObject

The target.

handler

RoutedEventHandler

The handler.

SetBetweenShowDelay(DependencyObject, int)

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

Declaration

cs-api-definition

public static void SetBetweenShowDelay(DependencyObject element, int value)

Parameters

element

DependencyObject

The element.

value

int

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.

Declaration

cs-api-definition

public static void SetHorizontalOffset(DependencyObject element, double value)

Parameters

element

DependencyObject

The element.

value

double

The value.

SetInitialShowDelay(DependencyObject, int)

Sets the length of time before a tooltip opens.

Declaration

cs-api-definition

public static void SetInitialShowDelay(DependencyObject element, int value)

Parameters

element

DependencyObject

The element.

value

int

The value.

SetIsEnabled(DependencyObject, bool)

Sets whether a tooltip appears.

Declaration

cs-api-definition

public static void SetIsEnabled(DependencyObject element, bool value)

Parameters

element

DependencyObject

The element.

value

bool

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.

Declaration

cs-api-definition

public static void SetPlacement(DependencyObject element, PlacementMode value)

Parameters

element

DependencyObject

The element.

value

PlacementMode

The value.

SetPlacementRectangle(DependencyObject, Rect)

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

Declaration

cs-api-definition

public static void SetPlacementRectangle(DependencyObject element, Rect value)

Parameters

element

DependencyObject

The element.

value

Rect

The value.

SetPlacementTarget(DependencyObject, UIElement)

Sets the object relative to which the tooltip is positioned.

Declaration

cs-api-definition

public static void SetPlacementTarget(DependencyObject element, UIElement value)

Parameters

element

DependencyObject

The element.

value

UIElement

The value.

SetShowDuration(DependencyObject, int)

Sets the amount of time that a tooltip remains visible.

Declaration

cs-api-definition

public static void SetShowDuration(DependencyObject element, int value)

Parameters

element

DependencyObject

The element.

value

int

The value.

SetToolTipContent(DependencyObject, object)

Sets the content of the ToolTip.

Declaration

cs-api-definition

public static void SetToolTipContent(DependencyObject element, object value)

Parameters

element

DependencyObject

The element.

value

object

The value.

SetToolTipContentTemplate(DependencyObject, DataTemplate)

Sets the ToolTip content template.

Declaration

cs-api-definition

public static void SetToolTipContentTemplate(DependencyObject element, DataTemplate value)

Parameters

element

DependencyObject

The element.

value

DataTemplate

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.

Declaration

cs-api-definition

public static void SetVerticalOffset(DependencyObject element, double value)

Parameters

element

DependencyObject

The element.

value

double

The value.

ClassRadToolTipService

Class
RadToolTipService