Avalonia API Reference
Tool
A control which pops up a hint when a control is hovered.
Definition
Namespace: Avalonia.Controls
Assembly: Avalonia.Controls (in Avalonia.Controls.dll) Version: 11.3.999
Assembly: Avalonia.Controls (in Avalonia.Controls.dll) Version: 11.3.999
C#
[PseudoClassesAttribute(new string[] { ... })]
public class ToolTip : ContentControl, IPopupHostProviderVB
<PseudoClassesAttribute(New String() { ... })>
Public Class ToolTip
Inherits ContentControl
Implements IPopupHostProviderF#
[<PseudoClassesAttribute(new string[] { ... })>]
type ToolTip =
class
inherit ContentControl
interface IPopupHostProvider
end- Inheritance
- Object AvaloniaObject Animatable StyledElement Visual Layoutable Interactive InputElement Control TemplatedControl ContentControl ToolTip
- Implements
- IPopupHostProvider
Remarks
You will probably not want to create a ToolTip control directly: if added to
the tree it will act as a simple ContentControl styled to look like a tooltip.
To add a tooltip to a control, use the TipProperty attached property,
assigning the content that you want displayed.
Constructors
| ToolTip | Initializes a new instance of the ToolTip class |
Properties
| ActualThemeVariant | (Inherited from StyledElement) |
| Background |
Gets or sets the brush used to draw the control's background.
(Inherited from TemplatedControl) |
| BackgroundSizing |
Gets or sets how the control's background is drawn relative to the control's border.
(Inherited from TemplatedControl) |
| BorderBrush |
Gets or sets the brush used to draw the control's border.
(Inherited from TemplatedControl) |
| BorderThickness |
Gets or sets the thickness of the control's border.
(Inherited from TemplatedControl) |
| Bounds | (Inherited from Visual) |
| BypassFlowDirectionPolicies | (Inherited from Visual) |
| Classes | (Inherited from StyledElement) |
| Clip | (Inherited from Visual) |
| ClipToBounds | (Inherited from Visual) |
| Content |
Gets or sets the content to display.
(Inherited from ContentControl) |
| ContentTemplate |
Gets or sets the data template used to display the content of the control.
(Inherited from ContentControl) |
| ContextFlyout |
Gets or sets a context flyout to the control
(Inherited from Control) |
| ContextMenu |
Gets or sets a context menu to the control.
(Inherited from Control) |
| CornerRadius |
Gets or sets the radius of the border rounded corners.
(Inherited from TemplatedControl) |
| Cursor | (Inherited from InputElement) |
| DataContext | (Inherited from StyledElement) |
| DataTemplates |
Gets or sets the data templates for the control.
(Inherited from Control) |
| DesiredSize | (Inherited from Layoutable) |
| Effect | (Inherited from Visual) |
| FlowDirection | (Inherited from Visual) |
| Focusable | (Inherited from InputElement) |
| FocusAdorner |
Gets or sets the control's focus adorner.
(Inherited from Control) |
| FontFamily |
Gets or sets the font family used to draw the control's text.
(Inherited from TemplatedControl) |
| FontFeatures |
Gets or sets the font features turned on/off.
(Inherited from TemplatedControl) |
| FontSize |
Gets or sets the size of the control's text in points.
(Inherited from TemplatedControl) |
| FontStretch |
Gets or sets the font stretch used to draw the control's text.
(Inherited from TemplatedControl) |
| FontStyle |
Gets or sets the font style used to draw the control's text.
(Inherited from TemplatedControl) |
| FontWeight |
Gets or sets the font weight used to draw the control's text.
(Inherited from TemplatedControl) |
| Foreground |
Gets or sets the brush used to draw the control's text and other foreground elements.
(Inherited from TemplatedControl) |
| GestureRecognizers | (Inherited from InputElement) |
| HasMirrorTransform | (Inherited from Visual) |
| Height | (Inherited from Layoutable) |
| HorizontalAlignment | (Inherited from Layoutable) |
| HorizontalContentAlignment |
Gets or sets the horizontal alignment of the content within the control.
(Inherited from ContentControl) |
| InheritanceParent | (Inherited from AvaloniaObject) |
| IsArrangeValid | (Inherited from Layoutable) |
| IsEffectivelyEnabled | (Inherited from InputElement) |
| IsEffectivelyVisible | (Inherited from Visual) |
| IsEnabled | (Inherited from InputElement) |
| IsEnabledCore | (Inherited from InputElement) |
| IsFocused | (Inherited from InputElement) |
| IsHitTestVisible | (Inherited from InputElement) |
| IsInitialized | (Inherited from StyledElement) |
| IsKeyboardFocusWithin | (Inherited from InputElement) |
| IsLoaded |
Gets a value indicating whether the control is fully constructed in the visual tree
and both layout and render are complete.
(Inherited from Control) |
| IsMeasureValid | (Inherited from Layoutable) |
| IsPointerOver | (Inherited from InputElement) |
| IsTabStop | (Inherited from InputElement) |
| IsVisible | (Inherited from Visual) |
| Item | (Inherited from AvaloniaObject) |
| Item | (Inherited from AvaloniaObject) |
| KeyBindings | (Inherited from InputElement) |
| LogicalChildren | (Inherited from StyledElement) |
| Margin | (Inherited from Layoutable) |
| MaxHeight | (Inherited from Layoutable) |
| MaxWidth | (Inherited from Layoutable) |
| MinHeight | (Inherited from Layoutable) |
| MinWidth | (Inherited from Layoutable) |
| Name | (Inherited from StyledElement) |
| Opacity | (Inherited from Visual) |
| OpacityMask | (Inherited from Visual) |
| Padding |
Gets or sets the padding placed between the border of the control and its content.
(Inherited from TemplatedControl) |
| Parent | (Inherited from StyledElement) |
| Presenter |
Gets the presenter from the control's template.
(Inherited from ContentControl) |
| PseudoClasses | (Inherited from StyledElement) |
| RenderTransform | (Inherited from Visual) |
| RenderTransformOrigin | (Inherited from Visual) |
| Resources | (Inherited from StyledElement) |
| StyleKey | (Inherited from StyledElement) |
| StyleKeyOverride | (Inherited from StyledElement) |
| Styles | (Inherited from StyledElement) |
| TabIndex | (Inherited from InputElement) |
| Tag |
Gets or sets a user-defined object attached to the control.
(Inherited from Control) |
| Template |
Gets or sets the template that defines the control's appearance.
(Inherited from TemplatedControl) |
| TemplatedParent | (Inherited from StyledElement) |
| Theme | (Inherited from StyledElement) |
| Transitions | (Inherited from Animatable) |
| UseLayoutRounding | (Inherited from Layoutable) |
| VerticalAlignment | (Inherited from Layoutable) |
| VerticalContentAlignment |
Gets or sets the vertical alignment of the content within the control.
(Inherited from ContentControl) |
| VisualChildren | (Inherited from Visual) |
| VisualRoot | (Inherited from Visual) |
| Width | (Inherited from Layoutable) |
| ZIndex | (Inherited from Visual) |
Methods
| AddHandler(RoutedEvent, Delegate, RoutingStrategies, Boolean) | (Inherited from Interactive) |
| AddHandler``1(RoutedEventUMP, EventHandlerUMP, RoutingStrategies, Boolean) | (Inherited from Interactive) |
| AddToolTipClosingHandler(Control, EventHandlerRoutedEventArgs) | Adds a handler for the ToolTipClosingEvent attached event. |
| AddToolTipOpeningHandler(Control, EventHandlerCancelRoutedEventArgs) | Adds a handler for the ToolTipOpeningEvent attached event. |
| ApplyStyling | (Inherited from StyledElement) |
| ApplyTemplate | (Inherited from TemplatedControl) |
| Arrange(Rect) | (Inherited from Layoutable) |
| ArrangeCore(Rect) | (Inherited from Layoutable) |
| ArrangeOverride(Size) | (Inherited from Layoutable) |
| BeginInit | (Inherited from StyledElement) |
| Bind(AvaloniaProperty, IBinding) | (Inherited from AvaloniaObject) |
| Bind(AvaloniaProperty, IObservableObject, BindingPriority) | (Inherited from AvaloniaObject) |
| Bind``1(DirectPropertyBaseUMP, IObservableUMP) | (Inherited from AvaloniaObject) |
| Bind``1(DirectPropertyBaseUMP, IObservableBindingValueUMP) | (Inherited from AvaloniaObject) |
| Bind``1(DirectPropertyBaseUMP, IObservableObject) | (Inherited from AvaloniaObject) |
| Bind``1(StyledPropertyUMP, IObservableUMP, BindingPriority) | (Inherited from AvaloniaObject) |
| Bind``1(StyledPropertyUMP, IObservableBindingValueUMP, BindingPriority) | (Inherited from AvaloniaObject) |
| Bind``1(StyledPropertyUMP, IObservableObject, BindingPriority) | (Inherited from AvaloniaObject) |
| BuildEventRoute(RoutedEvent) | (Inherited from Interactive) |
| CheckAccess | (Inherited from AvaloniaObject) |
| ClearValue(AvaloniaProperty) | (Inherited from AvaloniaObject) |
| ClearValue``1(AvaloniaPropertyUMP) | (Inherited from AvaloniaObject) |
| ClearValue``1(DirectPropertyBaseUMP) | (Inherited from AvaloniaObject) |
| ClearValue``1(StyledPropertyUMP) | (Inherited from AvaloniaObject) |
| CoerceValue(AvaloniaProperty) | (Inherited from AvaloniaObject) |
| EndInit | (Inherited from StyledElement) |
| Equals(Object) | (Inherited from AvaloniaObject) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| Focus(NavigationMethod, KeyModifiers) | (Inherited from InputElement) |
| GetBaseValue``1(StyledPropertyUMP) | (Inherited from AvaloniaObject) |
| GetBetweenShowDelay(Control) | Gets the number of milliseconds since the last tooltip closed during which the tooltip of element will open immediately, or a negative value indicating that the tooltip will always wait for ShowDelayProperty before opening. |
| GetCustomPopupPlacementCallback(Control) | Gets the value of the ToolTip.CustomPopupPlacementCallback attached property. |
| GetHashCode | (Inherited from AvaloniaObject) |
| GetHorizontalOffset(Control) | Gets the value of the ToolTip.HorizontalOffset attached property. |
| GetIsOpen(Control) | Gets the value of the ToolTip.IsOpen attached property. |
| GetPlacement(Control) | Gets the value of the ToolTip.Placement attached property. |
| GetServiceEnabled(Control) | Gets whether showing and hiding of a control's tooltip will be automatically controlled by Avalonia. |
| GetShowDelay(Control) | Gets the value of the ToolTip.ShowDelay attached property. |
| GetShowOnDisabled(Control) | Gets whether a control will display a tooltip even if it disabled. |
| GetTemplateFocusTarget |
Gets the element that receives the focus adorner.
(Inherited from TemplatedControl) |
| GetTip(Control) | Gets the value of the ToolTip.Tip attached property. |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| GetValue(AvaloniaProperty) | (Inherited from AvaloniaObject) |
| GetValue``1(DirectPropertyBaseUMP) | (Inherited from AvaloniaObject) |
| GetValue``1(StyledPropertyUMP) | (Inherited from AvaloniaObject) |
| GetVerticalOffset(Control) | Gets the value of the ToolTip.VerticalOffset attached property. |
| InitializeIfNeeded | (Inherited from StyledElement) |
| InvalidateArrange | (Inherited from Layoutable) |
| InvalidateMeasure | (Inherited from Layoutable) |
| InvalidateMirrorTransform | (Inherited from Visual) |
| InvalidateVisual | (Inherited from Visual) |
| IsAnimating(AvaloniaProperty) | (Inherited from AvaloniaObject) |
| IsSet(AvaloniaProperty) | (Inherited from AvaloniaObject) |
| LogicalChildrenCollectionChanged(Object, NotifyCollectionChangedEventArgs) | (Inherited from Visual) |
| Measure(Size) | (Inherited from Layoutable) |
| MeasureCore(Size) | (Inherited from Layoutable) |
| MeasureOverride(Size) | (Inherited from Layoutable) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| OnAccessKey(RoutedEventArgs) | (Inherited from InputElement) |
| OnApplyTemplate(TemplateAppliedEventArgs) |
Called when the control's template is applied.
In simple terms, this means the method is called just before the control is displayed.
(Inherited from TemplatedControl) |
| OnAttachedToLogicalTree(LogicalTreeAttachmentEventArgs) | (Inherited from TemplatedControl) |
| OnAttachedToVisualTree(VisualTreeAttachmentEventArgs) | (Inherited from Visual) |
| OnAttachedToVisualTreeCore(VisualTreeAttachmentEventArgs) | (Inherited from Control) |
| OnCreateAutomationPeer |
Returns a new, type-specific AutomationPeer implementation for the control.
(Inherited from Control) |
| OnDataContextBeginUpdate | (Inherited from StyledElement) |
| OnDataContextChanged(EventArgs) | (Inherited from StyledElement) |
| OnDataContextEndUpdate | (Inherited from StyledElement) |
| OnDetachedFromLogicalTree(LogicalTreeAttachmentEventArgs) | (Inherited from TemplatedControl) |
| OnDetachedFromVisualTree(VisualTreeAttachmentEventArgs) | (Inherited from Visual) |
| OnDetachedFromVisualTreeCore(VisualTreeAttachmentEventArgs) | (Inherited from Control) |
| OnGotFocus(GotFocusEventArgs) | (Inherited from Control) |
| OnInitialized | (Inherited from StyledElement) |
| OnKeyDown(KeyEventArgs) | (Inherited from InputElement) |
| OnKeyUp(KeyEventArgs) | (Inherited from Control) |
| OnLoaded(RoutedEventArgs) |
Invoked just before the Loaded event.
(Inherited from Control) |
| OnLostFocus(RoutedEventArgs) | (Inherited from Control) |
| OnMeasureInvalidated | (Inherited from Layoutable) |
| OnPointerCaptureLost(PointerCaptureLostEventArgs) | (Inherited from InputElement) |
| OnPointerEntered(PointerEventArgs) | (Inherited from InputElement) |
| OnPointerExited(PointerEventArgs) | (Inherited from InputElement) |
| OnPointerMoved(PointerEventArgs) | (Inherited from InputElement) |
| OnPointerPressed(PointerPressedEventArgs) | (Inherited from InputElement) |
| OnPointerReleased(PointerReleasedEventArgs) | (Inherited from Control) |
| OnPointerWheelChanged(PointerWheelEventArgs) | (Inherited from InputElement) |
| OnPropertyChanged(AvaloniaPropertyChangedEventArgs) | (Inherited from ContentControl) |
| OnPropertyChangedCore(AvaloniaPropertyChangedEventArgs) | (Inherited from Animatable) |
| OnSizeChanged(SizeChangedEventArgs) |
Invoked just before the SizeChanged event.
(Inherited from Control) |
| OnTemplateChanged(AvaloniaPropertyChangedEventArgs) |
Called when the Template property changes.
(Inherited from TemplatedControl) |
| OnTextInput(TextInputEventArgs) | (Inherited from InputElement) |
| OnUnloaded(RoutedEventArgs) |
Invoked just before the Unloaded event.
(Inherited from Control) |
| OnVisualParentChanged(Visual, Visual) | (Inherited from Layoutable) |
| RaiseEvent(RoutedEventArgs) | (Inherited from Interactive) |
| RaisePropertyChanged``1(DirectPropertyBaseUMP, UMP, UMP) | (Inherited from AvaloniaObject) |
| RegisterContentPresenter(ContentPresenter) |
Called when an ContentPresenter is registered with the control.
(Inherited from ContentControl) |
| RemoveHandler(RoutedEvent, Delegate) | (Inherited from Interactive) |
| RemoveHandler``1(RoutedEventUMP, EventHandlerUMP) | (Inherited from Interactive) |
| RemoveToolTipClosingHandler(Control, EventHandlerRoutedEventArgs) | Removes a handler for the ToolTipClosingEvent attached event. |
| RemoveToolTipOpeningHandler(Control, EventHandlerCancelRoutedEventArgs) | Removes a handler for the ToolTipOpeningEvent attached event. |
| Render(DrawingContext) | (Inherited from Visual) |
| SetAndRaise``1(DirectPropertyBaseUMP, UMP, UMP) | (Inherited from AvaloniaObject) |
| SetBetweenShowDelay(Control, Int32) | Sets the number of milliseconds since the last tooltip closed during which the tooltip of element will open immediately. |
| SetCurrentValue(AvaloniaProperty, Object) | (Inherited from AvaloniaObject) |
| SetCurrentValue``1(StyledPropertyUMP, UMP) | (Inherited from AvaloniaObject) |
| SetCustomPopupPlacementCallback(Control, CustomPopupPlacementCallback) | Sets the value of the ToolTip.CustomPopupPlacementCallback attached property. |
| SetHorizontalOffset(Control, Double) | Sets the value of the ToolTip.HorizontalOffset attached property. |
| SetIsOpen(Control, Boolean) | Sets the value of the ToolTip.IsOpen attached property. |
| SetPlacement(Control, PlacementMode) | Sets the value of the ToolTip.Placement attached property. |
| SetServiceEnabled(Control, Boolean) | Sets whether showing and hiding of a control's tooltip will be automatically controlled by Avalonia. |
| SetShowDelay(Control, Int32) | Sets the value of the ToolTip.ShowDelay attached property. |
| SetShowOnDisabled(Control, Boolean) | Sets whether a control will display a tooltip even if it disabled. |
| SetTip(Control, Object) | Sets the value of the ToolTip.Tip attached property. |
| SetValue(AvaloniaProperty, Object, BindingPriority) | (Inherited from AvaloniaObject) |
| SetValue``1(DirectPropertyBaseUMP, UMP) | (Inherited from AvaloniaObject) |
| SetValue``1(StyledPropertyUMP, UMP, BindingPriority) | (Inherited from AvaloniaObject) |
| SetVerticalOffset(Control, Double) | Sets the value of the ToolTip.VerticalOffset attached property. |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| TryGetResource(Object, ThemeVariant, Object) | (Inherited from StyledElement) |
| UpdateDataValidation(AvaloniaProperty, BindingValueType, Exception) | (Inherited from AvaloniaObject) |
| UpdateIsEffectivelyEnabled | (Inherited from InputElement) |
| UpdateLayout | (Inherited from Layoutable) |
| VerifyAccess | (Inherited from AvaloniaObject) |
Events
| ActualThemeVariantChanged | (Inherited from StyledElement) |
| AttachedToLogicalTree | (Inherited from StyledElement) |
| AttachedToVisualTree | (Inherited from Visual) |
| ContextRequested |
Occurs when the user has completed a context input gesture, such as a right-click.
(Inherited from Control) |
| DataContextChanged | (Inherited from StyledElement) |
| DetachedFromLogicalTree | (Inherited from StyledElement) |
| DetachedFromVisualTree | (Inherited from Visual) |
| DoubleTapped | (Inherited from InputElement) |
| EffectiveViewportChanged | (Inherited from Layoutable) |
| GotFocus | (Inherited from InputElement) |
| Holding | (Inherited from InputElement) |
| Initialized | (Inherited from StyledElement) |
| KeyDown | (Inherited from InputElement) |
| KeyUp | (Inherited from InputElement) |
| LayoutUpdated | (Inherited from Layoutable) |
| Loaded |
Occurs when the control has been fully constructed in the visual tree and both
layout and render are complete.
(Inherited from Control) |
| LostFocus | (Inherited from InputElement) |
| PointerCaptureLost | (Inherited from InputElement) |
| PointerEntered | (Inherited from InputElement) |
| PointerExited | (Inherited from InputElement) |
| PointerMoved | (Inherited from InputElement) |
| PointerPressed | (Inherited from InputElement) |
| PointerReleased | (Inherited from InputElement) |
| PointerWheelChanged | (Inherited from InputElement) |
| PropertyChanged | (Inherited from AvaloniaObject) |
| ResourcesChanged | (Inherited from StyledElement) |
| SizeChanged |
Occurs when the bounds (actual size) of the control have changed.
(Inherited from Control) |
| Tapped | (Inherited from InputElement) |
| TemplateApplied |
Raised when the control's template is applied.
(Inherited from TemplatedControl) |
| TextInput | (Inherited from InputElement) |
| TextInputMethodClientRequested | (Inherited from InputElement) |
| Unloaded |
Occurs when the control is removed from the visual tree.
(Inherited from Control) |
Fields
| BetweenShowDelayProperty | Defines the ToolTip.BetweenShowDelay property. |
| CustomPopupPlacementCallbackProperty | Defines the CustomPopupPlacementCallback property. |
| HorizontalOffsetProperty | Defines the ToolTip.HorizontalOffset property. |
| IsOpenProperty | Defines the ToolTip.IsOpen attached property. |
| PlacementProperty | Defines the ToolTip.Placement property. |
| ServiceEnabledProperty | Defines the ToolTip.ServiceEnabled property. |
| ShowDelayProperty | Defines the ToolTip.ShowDelay property. |
| ShowOnDisabledProperty | Defines the ToolTip.ShowOnDisabled property. |
| TipProperty | Defines the ToolTip.Tip attached property. |
| ToolTipClosingEvent | The event raised when a ToolTip on an element that was shown should now be hidden. |
| ToolTipOpeningEvent | The event raised when a ToolTip is going to be shown on an element. |
| VerticalOffsetProperty | Defines the ToolTip.VerticalOffset property. |
Extension Methods
| BringIntoView |
Tries to bring the control into view.
(Defined by ControlExtensions) |
| BringIntoView(Rect) |
Tries to bring the control into view.
(Defined by ControlExtensions) |
| FindControlT(String) |
Finds the named control in the scope of the specified control.
(Defined by ControlExtensions) |
| FindDataTemplate(Object, IDataTemplate) |
Find a data template that matches a piece of data.
(Defined by DataTemplateExtensions) |
| GetControlT(String) |
Finds the named control in the scope of the specified control and throws if not found.
(Defined by ControlExtensions) |
| GetTemplateChildren | (Defined by TemplateExtensions) |