Class RadToolTipService

Represents a service that provides properties and events to control the display and behavior of tooltips.

Inheritance

System.Object

RadToolTipService

Namespace: Telerik.Windows.Controls

Assembly: Telerik.Windows.Controls.dll

Syntax

public static class RadToolTipService : Object

Fields

BetweenShowDelayProperty

Identifies the BetweenShowDelay dependency property.

Declaration

public static readonly DependencyProperty BetweenShowDelayProperty

Field Value

System.Windows.DependencyProperty

HorizontalOffsetProperty

Identifies the HorizontalOffset dependency property.

Declaration

public static readonly DependencyProperty HorizontalOffsetProperty

Field Value

System.Windows.DependencyProperty

InitialShowDelayProperty

Identifies the InitialShowDelay dependency property.

Declaration

public static readonly DependencyProperty InitialShowDelayProperty

Field Value

System.Windows.DependencyProperty

IsEnabledProperty

Identifies the IsEnabled dependency property.

Declaration

public static readonly DependencyProperty IsEnabledProperty

Field Value

System.Windows.DependencyProperty

IsOpenProperty

Identifies the IsOpen dependency property.

Declaration

public static readonly DependencyProperty IsOpenProperty

Field Value

System.Windows.DependencyProperty

PlacementProperty

Identifies the Placement dependency property.

Declaration

public static readonly DependencyProperty PlacementProperty

Field Value

System.Windows.DependencyProperty

PlacementRectangleProperty

Identifies the PlacementRectangle dependency property.

Declaration

public static readonly DependencyProperty PlacementRectangleProperty

Field Value

System.Windows.DependencyProperty

PlacementTargetProperty

Identifies the PlacementTarget dependency property.

Declaration

public static readonly DependencyProperty PlacementTargetProperty

Field Value

System.Windows.DependencyProperty

ShowDurationProperty

Identifies the ShowDuration dependency property.

Declaration

public static readonly DependencyProperty ShowDurationProperty

Field Value

System.Windows.DependencyProperty

ToolTipClosingEvent

Identifies the ToolTipClosing routed event.

Declaration

public static readonly RoutedEvent ToolTipClosingEvent

Field Value

System.Windows.RoutedEvent

ToolTipContentProperty

Identifies the ToolTipContent dependency property.

Declaration

public static readonly DependencyProperty ToolTipContentProperty

Field Value

System.Windows.DependencyProperty

ToolTipContentTemplateProperty

Identifies the ToolTipContentTemplate dependency property.

Declaration

public static readonly DependencyProperty ToolTipContentTemplateProperty

Field Value

System.Windows.DependencyProperty

ToolTipOpeningEvent

Identifies the ToolTipOpening routed event.

Declaration

public static readonly RoutedEvent ToolTipOpeningEvent

Field Value

System.Windows.RoutedEvent

VerticalOffsetProperty

Identifies the VerticalOffset dependency property.

Declaration

public static readonly DependencyProperty VerticalOffsetProperty

Field Value

System.Windows.DependencyProperty

Methods

AddToolTipClosingHandler(DependencyObject, RoutedEventHandler)

Adds handler for the ToolTipClosing event.

Declaration

public static void AddToolTipClosingHandler(DependencyObject target, RoutedEventHandler handler)

Parameters

System.Windows.DependencyObject target The target.

System.Windows.RoutedEventHandler handler The handler.

AddToolTipOpeningHandler(DependencyObject, RoutedEventHandler)

Adds handler for the ToolTipOpening event.

Declaration

public static void AddToolTipOpeningHandler(DependencyObject target, RoutedEventHandler handler)

Parameters

System.Windows.DependencyObject target The target.

System.Windows.RoutedEventHandler handler The handler.

GetBetweenShowDelay(DependencyObject)

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

Declaration

public static int GetBetweenShowDelay(DependencyObject element)

Parameters

System.Windows.DependencyObject element The element.

Returns

System.Int32

GetHorizontalOffset(DependencyObject)

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

Declaration

public static double GetHorizontalOffset(DependencyObject element)

Parameters

System.Windows.DependencyObject element The element.

Returns

System.Double

GetInitialShowDelay(DependencyObject)

Gets the length of time before a tooltip opens.

Declaration

public static int GetInitialShowDelay(DependencyObject element)

Parameters

System.Windows.DependencyObject element The element.

Returns

System.Int32

GetIsEnabled(DependencyObject)

Gets whether a tooltip appears.

Declaration

public static bool GetIsEnabled(DependencyObject element)

Parameters

System.Windows.DependencyObject element The element.

Returns

System.Boolean

GetIsOpen(DependencyObject)

Gets whether a tooltip is currently visible.

Declaration

public static bool GetIsOpen(DependencyObject element)

Parameters

System.Windows.DependencyObject element The element.

Returns

System.Boolean

GetPlacement(DependencyObject)

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

Declaration

public static PlacementMode GetPlacement(DependencyObject element)

Parameters

System.Windows.DependencyObject element The element.

Returns

System.Windows.Controls.Primitives.PlacementMode

GetPlacementRectangle(DependencyObject)

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

Declaration

public static Rect GetPlacementRectangle(DependencyObject element)

Parameters

System.Windows.DependencyObject element The element.

Returns

System.Windows.Rect

GetPlacementTarget(DependencyObject)

Gets the object relative to which the tooltip is positioned.

Declaration

public static UIElement GetPlacementTarget(DependencyObject element)

Parameters

System.Windows.DependencyObject element The element.

Returns

System.Windows.UIElement

GetShowDuration(DependencyObject)

Gets the amount of time that a tooltip remains visible.

Declaration

public static int GetShowDuration(DependencyObject element)

Parameters

System.Windows.DependencyObject element The element.

Returns

System.Int32

GetToolTipContent(DependencyObject)

Gets the content of the ToolTip.

Declaration

public static object GetToolTipContent(DependencyObject element)

Parameters

System.Windows.DependencyObject element The element.

Returns

System.Object

GetToolTipContentTemplate(DependencyObject)

Gets the ToolTip content template.

Declaration

public static DataTemplate GetToolTipContentTemplate(DependencyObject element)

Parameters

System.Windows.DependencyObject element The element.

Returns

System.Windows.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

public static double GetVerticalOffset(DependencyObject element)

Parameters

System.Windows.DependencyObject element The element.

Returns

System.Double

HideTooltip(FrameworkElement)

Hides the tooltip.

Declaration

public static void HideTooltip(FrameworkElement owner)

Parameters

System.Windows.FrameworkElement owner The owner of the tooltip.

RemoveToolTipClosingHandler(DependencyObject, RoutedEventHandler)

Removes handler for the ToolTipClosing event.

Declaration

public static void RemoveToolTipClosingHandler(DependencyObject target, RoutedEventHandler handler)

Parameters

System.Windows.DependencyObject target The target.

System.Windows.RoutedEventHandler handler The handler.

RemoveToolTipOpeningHandler(DependencyObject, RoutedEventHandler)

Removes handler for the ToolTipOpening event.

Declaration

public static void RemoveToolTipOpeningHandler(DependencyObject target, RoutedEventHandler handler)

Parameters

System.Windows.DependencyObject target The target.

System.Windows.RoutedEventHandler handler The handler.

SetBetweenShowDelay(DependencyObject, Int32)

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

Declaration

public static void SetBetweenShowDelay(DependencyObject element, int value)

Parameters

System.Windows.DependencyObject element The element.

System.Int32 value 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

public static void SetHorizontalOffset(DependencyObject element, double value)

Parameters

System.Windows.DependencyObject element The element.

System.Double value The value.

SetInitialShowDelay(DependencyObject, Int32)

Sets the length of time before a tooltip opens.

Declaration

public static void SetInitialShowDelay(DependencyObject element, int value)

Parameters

System.Windows.DependencyObject element The element.

System.Int32 value The value.

SetIsEnabled(DependencyObject, Boolean)

Sets whether a tooltip appears.

Declaration

public static void SetIsEnabled(DependencyObject element, bool value)

Parameters

System.Windows.DependencyObject element The element.

System.Boolean value 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

public static void SetPlacement(DependencyObject element, PlacementMode value)

Parameters

System.Windows.DependencyObject element The element.

System.Windows.Controls.Primitives.PlacementMode value The value.

SetPlacementRectangle(DependencyObject, Rect)

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

Declaration

public static void SetPlacementRectangle(DependencyObject element, Rect value)

Parameters

System.Windows.DependencyObject element The element.

System.Windows.Rect value The value.

SetPlacementTarget(DependencyObject, UIElement)

Sets the object relative to which the tooltip is positioned.

Declaration

public static void SetPlacementTarget(DependencyObject element, UIElement value)

Parameters

System.Windows.DependencyObject element The element.

System.Windows.UIElement value The value.

SetShowDuration(DependencyObject, Int32)

Sets the amount of time that a tooltip remains visible.

Declaration

public static void SetShowDuration(DependencyObject element, int value)

Parameters

System.Windows.DependencyObject element The element.

System.Int32 value The value.

SetToolTipContent(DependencyObject, Object)

Sets the content of the ToolTip.

Declaration

public static void SetToolTipContent(DependencyObject element, object value)

Parameters

System.Windows.DependencyObject element The element.

System.Object value The value.

SetToolTipContentTemplate(DependencyObject, DataTemplate)

Sets the ToolTip content template.

Declaration

public static void SetToolTipContentTemplate(DependencyObject element, DataTemplate value)

Parameters

System.Windows.DependencyObject element The element.

System.Windows.DataTemplate value 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

public static void SetVerticalOffset(DependencyObject element, double value)

Parameters

System.Windows.DependencyObject element The element.

System.Double value The value.