ToolTip Class
Definition
A control which pops up a hint when a control is hovered.
public class ToolTip
Remarks
You will probably not want to create a Avalonia.Controls.ToolTip control directly: if added to the tree it will act as a simple Avalonia.Controls.ContentControl styled to look like a tooltip. To add a tooltip to a control, use the Avalonia.Controls.ToolTip.TipProperty attached property, assigning the content that you want displayed.
Constructors
| Name | Description |
|---|---|
| ToolTip | No summary available. |
ToolTip Constructor
public ToolTip()
Methods
| Name | Description |
|---|---|
| AddHandler (2 overloads) | Adds a handler for the specified routed event. Inherited from Interactive. |
| AddToolTipClosingHandler | No summary available. |
| AddToolTipOpeningHandler | No summary available. |
| ApplyStyling | Applies styling to the control if the control is initialized and styling is not already applied. Inherited from StyledElement. |
| ApplyTemplate | Creates the visual children of the control, if necessary Inherited from TemplatedControl. |
| Arrange | Arranges the control and its children. Inherited from Layoutable. |
| BeginInit | Inherited from StyledElement. |
| Bind (8 overloads) | Binds a Avalonia.AvaloniaProperty to an Avalonia.Data.BindingBase. Inherited from AvaloniaObject. |
| CheckAccess | Returns a value indicating whether the current thread is the UI thread. Inherited from AvaloniaObject. |
| ClearValue (4 overloads) | Clears a Avalonia.AvaloniaProperty's local value. Inherited from AvaloniaObject. |
| CoerceValue | Coerces the specified Avalonia.AvaloniaProperty. Inherited from AvaloniaObject. |
| EndInit | Inherited from StyledElement. |
| Equals | Compares two objects using reference equality. Inherited from AvaloniaObject. |
| Focus | Focuses the control. Inherited from InputElement. |
| GetBaseValue | Inherited from AvaloniaObject. |
| GetBetweenShowDelay | 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 Avalonia.Controls.ToolTip.ShowDelayProperty before opening. |
| GetCustomPopupPlacementCallback | Gets the value of the ToolTip.CustomPopupPlacementCallback attached property. |
| GetFlowDirection | Gets the value of the attached Avalonia.Visual.FlowDirectionProperty on a control. Inherited from Visual. |
| GetHashCode | Gets the hash code for the object. Inherited from AvaloniaObject. |
| GetHorizontalOffset | Gets the value of the ToolTip.HorizontalOffset attached property. |
| GetIsHoldingEnabled | Inherited from InputElement. |
| GetIsHoldWithMouseEnabled | Inherited from InputElement. |
| GetIsOpen | Gets the value of the ToolTip.IsOpen attached property. |
| GetIsTemplateFocusTarget | Gets the value of the IsTemplateFocusTargetProperty attached property on a control. Inherited from TemplatedControl. |
| GetPlacement | Gets the value of the ToolTip.Placement attached property. |
| GetServiceEnabled | Gets whether showing and hiding of a control's tooltip will be automatically controlled by Avalonia. |
| GetShouldUseOverlayLayer | Gets whether the tooltip popup for element is shown in the overlay layer. |
| GetShowDelay | Gets the value of the ToolTip.ShowDelay attached property. |
| GetShowOnDisabled | Gets whether a control will display a tooltip even if it disabled. |
| GetTip | Gets the value of the ToolTip.Tip attached property. |
| GetValue (3 overloads) | Gets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject. |
| GetVerticalOffset | Gets the value of the ToolTip.VerticalOffset attached property. |
| InvalidateArrange | Invalidates the arrangement of the control and queues a new layout pass. Inherited from Layoutable. |
| InvalidateMeasure | Invalidates the measurement of the control and queues a new layout pass. Inherited from Layoutable. |
| InvalidateVisual | Invalidates the visual and queues a repaint. Inherited from Visual. |
| IsAnimating | Checks whether a Avalonia.AvaloniaProperty is animating. Inherited from AvaloniaObject. |
| IsSet | Checks whether a Avalonia.AvaloniaProperty is set on this object. Inherited from AvaloniaObject. |
| Measure | Carries out a measure of the control. Inherited from Layoutable. |
| RaiseEvent | Raises a routed event. Inherited from Interactive. |
| RemoveHandler (2 overloads) | Removes a handler for the specified routed event. Inherited from Interactive. |
| RemoveToolTipClosingHandler | No summary available. |
| RemoveToolTipOpeningHandler | No summary available. |
| Render | Renders the visual to a Avalonia.Media.DrawingContext. Inherited from Visual. |
| SetBetweenShowDelay | Sets the number of milliseconds since the last tooltip closed during which the tooltip of element will open immediately. |
| SetCurrentValue (2 overloads) | Sets the value of a dependency property without changing its value source. Inherited from AvaloniaObject. |
| SetCustomPopupPlacementCallback | Sets the value of the ToolTip.CustomPopupPlacementCallback attached property. |
| SetFlowDirection | Sets the value of the attached Avalonia.Visual.FlowDirectionProperty on a control. Inherited from Visual. |
| SetHorizontalOffset | Sets the value of the ToolTip.HorizontalOffset attached property. |
| SetIsHoldingEnabled | Inherited from InputElement. |
| SetIsHoldWithMouseEnabled | Inherited from InputElement. |
| SetIsOpen | Sets the value of the ToolTip.IsOpen attached property. |
| SetIsTemplateFocusTarget | Sets the value of the IsTemplateFocusTargetProperty attached property on a control. Inherited from TemplatedControl. |
| SetPlacement | Sets the value of the ToolTip.Placement attached property. |
| SetServiceEnabled | Sets whether showing and hiding of a control's tooltip will be automatically controlled by Avalonia. |
| SetShouldUseOverlayLayer | Sets whether the tooltip popup for element is shown in the overlay layer. |
| SetShowDelay | Sets the value of the ToolTip.ShowDelay attached property. |
| SetShowOnDisabled | Sets whether a control will display a tooltip even if it disabled. |
| SetTip | Sets the value of the ToolTip.Tip attached property. |
| SetValue (3 overloads) | Sets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject. |
| SetVerticalOffset | Sets the value of the ToolTip.VerticalOffset attached property. |
| TryGetResource | Inherited from StyledElement. |
| UpdateLayout | Executes a layout pass. Inherited from Layoutable. |
| VerifyAccess | Checks that the current thread is the UI thread and throws if not. Inherited from AvaloniaObject. |
AddToolTipClosingHandler Method
public void AddToolTipClosingHandler(Avalonia.Controls.Control element, EventHandler<Avalonia.Interactivity.RoutedEventArgs> handler)
Parameters
element Avalonia.Controls.Control
handler EventHandler<Avalonia.Interactivity.RoutedEventArgs>
AddToolTipOpeningHandler Method
public void AddToolTipOpeningHandler(Avalonia.Controls.Control element, EventHandler<Avalonia.Interactivity.CancelRoutedEventArgs> handler)
Parameters
element Avalonia.Controls.Control
handler EventHandler<Avalonia.Interactivity.CancelRoutedEventArgs>
GetBetweenShowDelay Method
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 Avalonia.Controls.ToolTip.ShowDelayProperty before opening.
public int GetBetweenShowDelay(Avalonia.Controls.Control element)
Parameters
element Avalonia.Controls.Control
The control to get the property from.
Returns
int
GetCustomPopupPlacementCallback Method
Gets the value of the ToolTip.CustomPopupPlacementCallback attached property.
public Avalonia.Controls.Primitives.PopupPositioning.CustomPopupPlacementCallback GetCustomPopupPlacementCallback(Avalonia.Controls.Control element)
Parameters
element Avalonia.Controls.Control
Returns
Avalonia.Controls.Primitives.PopupPositioning.CustomPopupPlacementCallback
GetHorizontalOffset Method
Gets the value of the ToolTip.HorizontalOffset attached property.
public double GetHorizontalOffset(Avalonia.Controls.Control element)
Parameters
element Avalonia.Controls.Control
The control to get the property from.
Returns
double
A value indicating how the tool tip is positioned.
GetIsOpen Method
Gets the value of the ToolTip.IsOpen attached property.
public bool GetIsOpen(Avalonia.Controls.Control element)
Parameters
element Avalonia.Controls.Control
The control to get the property from.
Returns
bool
A value indicating whether the tool tip is visible.
GetPlacement Method
Gets the value of the ToolTip.Placement attached property.
public Avalonia.Controls.PlacementMode GetPlacement(Avalonia.Controls.Control element)
Parameters
element Avalonia.Controls.Control
The control to get the property from.
Returns
Avalonia.Controls.PlacementMode
A value indicating how the tool tip is positioned.
GetServiceEnabled Method
Gets whether showing and hiding of a control's tooltip will be automatically controlled by Avalonia.
public bool GetServiceEnabled(Avalonia.Controls.Control element)
Parameters
element Avalonia.Controls.Control
The control to get the property from.
Returns
bool
GetShouldUseOverlayLayer Method
Gets whether the tooltip popup for element is shown in the overlay layer.
public bool GetShouldUseOverlayLayer(Avalonia.Controls.Control element)
Parameters
element Avalonia.Controls.Control
The control to get the property from.
Returns
bool
Remarks
See Avalonia.Controls.Primitives.Popup.ShouldUseOverlayLayer for details.
GetShowDelay Method
Gets the value of the ToolTip.ShowDelay attached property.
public int GetShowDelay(Avalonia.Controls.Control element)
Parameters
element Avalonia.Controls.Control
The control to get the property from.
Returns
int
A value indicating the time, in milliseconds, before a tool tip opens.
GetShowOnDisabled Method
Gets whether a control will display a tooltip even if it disabled.
public bool GetShowOnDisabled(Avalonia.Controls.Control element)
Parameters
element Avalonia.Controls.Control
The control to get the property from.
Returns
bool
GetTip Method
Gets the value of the ToolTip.Tip attached property.
public object GetTip(Avalonia.Controls.Control element)
Parameters
element Avalonia.Controls.Control
The control to get the property from.
Returns
object
The content to be displayed in the control's tooltip.
GetVerticalOffset Method
Gets the value of the ToolTip.VerticalOffset attached property.
public double GetVerticalOffset(Avalonia.Controls.Control element)
Parameters
element Avalonia.Controls.Control
The control to get the property from.
Returns
double
A value indicating how the tool tip is positioned.
RemoveToolTipClosingHandler Method
public void RemoveToolTipClosingHandler(Avalonia.Controls.Control element, EventHandler<Avalonia.Interactivity.RoutedEventArgs> handler)
Parameters
element Avalonia.Controls.Control
handler EventHandler<Avalonia.Interactivity.RoutedEventArgs>
RemoveToolTipOpeningHandler Method
public void RemoveToolTipOpeningHandler(Avalonia.Controls.Control element, EventHandler<Avalonia.Interactivity.CancelRoutedEventArgs> handler)
Parameters
element Avalonia.Controls.Control
handler EventHandler<Avalonia.Interactivity.CancelRoutedEventArgs>
SetBetweenShowDelay Method
Sets the number of milliseconds since the last tooltip closed during which the tooltip of element will open immediately.
public void SetBetweenShowDelay(Avalonia.Controls.Control element, int value)
Parameters
element Avalonia.Controls.Control
The control to get the property from.
value int
The number of milliseconds to set, or a negative value to disable the behaviour.
Remarks
Setting a negative value disables the immediate opening behaviour. The tooltip of element will then always wait until
Avalonia.Controls.ToolTip.ShowDelayProperty elapses before showing.
SetCustomPopupPlacementCallback Method
Sets the value of the ToolTip.CustomPopupPlacementCallback attached property.
public void SetCustomPopupPlacementCallback(Avalonia.Controls.Control element, Avalonia.Controls.Primitives.PopupPositioning.CustomPopupPlacementCallback value)
Parameters
element Avalonia.Controls.Control
value Avalonia.Controls.Primitives.PopupPositioning.CustomPopupPlacementCallback
SetHorizontalOffset Method
Sets the value of the ToolTip.HorizontalOffset attached property.
public void SetHorizontalOffset(Avalonia.Controls.Control element, double value)
Parameters
element Avalonia.Controls.Control
The control to get the property from.
value double
A value indicating how the tool tip is positioned.
SetIsOpen Method
Sets the value of the ToolTip.IsOpen attached property.
public void SetIsOpen(Avalonia.Controls.Control element, bool value)
Parameters
element Avalonia.Controls.Control
The control to get the property from.
value bool
A value indicating whether the tool tip is visible.
SetPlacement Method
Sets the value of the ToolTip.Placement attached property.
public void SetPlacement(Avalonia.Controls.Control element, Avalonia.Controls.PlacementMode value)
Parameters
element Avalonia.Controls.Control
The control to get the property from.
value Avalonia.Controls.PlacementMode
A value indicating how the tool tip is positioned.
SetServiceEnabled Method
Sets whether showing and hiding of a control's tooltip will be automatically controlled by Avalonia.
public void SetServiceEnabled(Avalonia.Controls.Control element, bool value)
Parameters
element Avalonia.Controls.Control
The control to get the property from.
value bool
Whether the control is to display a tooltip even if it disabled.
SetShouldUseOverlayLayer Method
Sets whether the tooltip popup for element is shown in the overlay layer.
public void SetShouldUseOverlayLayer(Avalonia.Controls.Control element, bool value)
Parameters
element Avalonia.Controls.Control
The control to set the property on.
value bool
Whether to show the tooltip popup in the overlay layer.
Remarks
See Avalonia.Controls.Primitives.Popup.ShouldUseOverlayLayer for details.
SetShowDelay Method
Sets the value of the ToolTip.ShowDelay attached property.
public void SetShowDelay(Avalonia.Controls.Control element, int value)
Parameters
element Avalonia.Controls.Control
The control to get the property from.
value int
A value indicating the time, in milliseconds, before a tool tip opens.
SetShowOnDisabled Method
Sets whether a control will display a tooltip even if it disabled.
public void SetShowOnDisabled(Avalonia.Controls.Control element, bool value)
Parameters
element Avalonia.Controls.Control
The control to get the property from.
value bool
Whether the control is to display a tooltip even if it disabled.
SetTip Method
Sets the value of the ToolTip.Tip attached property.
public void SetTip(Avalonia.Controls.Control element, object value)
Parameters
element Avalonia.Controls.Control
The control to get the property from.
value object
The content to be displayed in the control's tooltip.
SetVerticalOffset Method
Sets the value of the ToolTip.VerticalOffset attached property.
public void SetVerticalOffset(Avalonia.Controls.Control element, double value)
Parameters
element Avalonia.Controls.Control
The control to get the property from.
value double
A value indicating how the tool tip is positioned.
Properties
| Name | Description |
|---|---|
| ActualThemeVariant | Gets the UI theme that is currently used by the element, which might be different than the RequestedThemeVariantProperty. 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 | Gets the bounds of the control relative to its parent. Inherited from Visual. |
| CacheMode | Gets or sets the cache mode of the visual. Inherited from Visual. |
| Classes | Gets or sets the styled element's classes. Inherited from StyledElement. |
| Clip | Gets or sets the geometry clip for this visual. Inherited from Visual. |
| ClipToBounds | Gets or sets a value indicating whether the control should be clipped to its bounds. 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 | Gets or sets associated mouse cursor. Inherited from InputElement. |
| DataContext | Gets or sets the control's data context. Inherited from StyledElement. |
| DataTemplates | Gets or sets the data templates for the control. Inherited from Control. |
| DesiredSize | Gets the size that this element computed during the measure pass of the layout process. Inherited from Layoutable. |
| Dispatcher | Returns the Avalonia.AvaloniaObject.Dispatcher that this Avalonia.AvaloniaObject is associated with. Inherited from AvaloniaObject. |
| Effect | Gets or sets the effect of the control. Inherited from Visual. |
| FlowDirection | Gets or sets the text flow direction. Inherited from Visual. |
| Focusable | Gets or sets a value indicating whether the control can receive focus. 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 | Gets or sets a value indicating whether to apply mirror transform on this control. Inherited from Visual. |
| Height | Gets or sets the height of the element. Inherited from Layoutable. |
| HorizontalAlignment | Gets or sets the element's preferred horizontal alignment in its parent. Inherited from Layoutable. |
| HorizontalContentAlignment | Gets or sets the horizontal alignment of the content within the control. Inherited from ContentControl. |
| IsArrangeValid | Gets a value indicating whether the control's layouts arrange is valid. Inherited from Layoutable. |
| IsEffectivelyEnabled | Gets a value indicating whether this control and all its parents are enabled. Inherited from InputElement. |
| IsEffectivelyVisible | Gets a value indicating whether this control and all its parents are visible. Inherited from Visual. |
| IsEnabled | Gets or sets a value indicating whether the control is enabled for user interaction. Inherited from InputElement. |
| IsFocused | Gets a value indicating whether the control is focused. Inherited from InputElement. |
| IsHitTestVisible | Gets or sets a value indicating whether the control is considered for hit testing. Inherited from InputElement. |
| IsInitialized | Gets a value that indicates whether the element has finished initialization. Inherited from StyledElement. |
| IsKeyboardFocusWithin | Gets a value indicating whether keyboard focus is anywhere within the element or its visual tree child elements. 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 | Gets a value indicating whether the control's layout measure is valid. Inherited from Layoutable. |
| IsPointerOver | Gets a value indicating whether the pointer is currently over the control. Inherited from InputElement. |
| IsTabStop | Gets or sets a value that indicates whether the control is included in tab navigation. Inherited from InputElement. |
| IsVisible | Gets or sets a value indicating whether this control is visible. Inherited from Visual. |
| Item | Inherited from AvaloniaObject. |
| KeyBindings | Inherited from InputElement. |
| LetterSpacing | Gets or sets the letter spacing for the control's text content. Inherited from TemplatedControl. |
| Margin | Gets or sets the margin around the element. Inherited from Layoutable. |
| MaxHeight | Gets or sets the maximum height of the element. Inherited from Layoutable. |
| MaxWidth | Gets or sets the maximum width of the element. Inherited from Layoutable. |
| MinHeight | Gets or sets the minimum height of the element. Inherited from Layoutable. |
| MinWidth | Gets or sets the minimum width of the element. Inherited from Layoutable. |
| Name | Gets or sets the name of the styled element. Inherited from StyledElement. |
| Opacity | Gets or sets the opacity of the control. Inherited from Visual. |
| OpacityMask | Gets or sets the opacity mask of the control. Inherited from Visual. |
| Padding | Gets or sets the padding placed between the border of the control and its content. Inherited from TemplatedControl. |
| Parent | Gets the styled element's logical parent. Inherited from StyledElement. |
| Presenter | Gets the presenter from the control's template. Inherited from ContentControl. |
| RenderTransform | Gets or sets the render transform of the control. Inherited from Visual. |
| RenderTransformOrigin | Gets or sets the transform origin of the control. Inherited from Visual. |
| Resources | Gets or sets the styled element's resource dictionary. Inherited from StyledElement. |
| StyleKey | Gets the type by which the element is styled. Inherited from StyledElement. |
| Styles | Gets the styles for the styled element. Inherited from StyledElement. |
| TabIndex | Gets or sets a value that determines the order in which elements receive focus when the user navigates through controls by pressing the Tab key. 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 | Gets the styled element whose lookless template this styled element is part of. Inherited from StyledElement. |
| Theme | Gets or sets the theme to be applied to the element. Inherited from StyledElement. |
| Transitions | Gets or sets the property transitions for the control. Inherited from Animatable. |
| UseLayoutRounding | Gets or sets a value that determines whether the element should be snapped to pixel boundaries at layout time. Inherited from Layoutable. |
| VerticalAlignment | Gets or sets the element's preferred vertical alignment in its parent. Inherited from Layoutable. |
| VerticalContentAlignment | Gets or sets the vertical alignment of the content within the control. Inherited from ContentControl. |
| Width | Gets or sets the width of the element. Inherited from Layoutable. |
| ZIndex | Gets or sets the Z index of the control. Inherited from Visual. |
Fields
BetweenShowDelayProperty Field
Defines the ToolTip.BetweenShowDelay property.
public Avalonia.AttachedProperty<int> BetweenShowDelayProperty
CustomPopupPlacementCallbackProperty Field
Defines the Avalonia.Controls.Primitives.Popup.CustomPopupPlacementCallback property.
public Avalonia.AttachedProperty<Avalonia.Controls.Primitives.PopupPositioning.CustomPopupPlacementCallback> CustomPopupPlacementCallbackProperty
HorizontalOffsetProperty Field
Defines the ToolTip.HorizontalOffset property.
public Avalonia.AttachedProperty<double> HorizontalOffsetProperty
IsOpenProperty Field
Defines the ToolTip.IsOpen attached property.
public Avalonia.AttachedProperty<bool> IsOpenProperty
PlacementProperty Field
Defines the ToolTip.Placement property.
public Avalonia.AttachedProperty<Avalonia.Controls.PlacementMode> PlacementProperty
ServiceEnabledProperty Field
Defines the ToolTip.ServiceEnabled property.
public Avalonia.AttachedProperty<bool> ServiceEnabledProperty
ShouldUseOverlayLayerProperty Field
Gets or sets a value that indicates whether the popup should be shown in the overlay layer of the parent window.
public Avalonia.AttachedProperty<bool> ShouldUseOverlayLayerProperty
Remarks
When Avalonia.Controls.Primitives.Popup.ShouldUseOverlayLayer is "false" implementation depends on the platform.
Use Avalonia.Controls.Primitives.Popup.IsUsingOverlayLayer to get actual popup behavior.
This is an equvalent of OverlayPopups property of the platform options, but settable independently per each popup.
ShowDelayProperty Field
Defines the ToolTip.ShowDelay property.
public Avalonia.AttachedProperty<int> ShowDelayProperty
ShowOnDisabledProperty Field
Defines the ToolTip.ShowOnDisabled property.
public Avalonia.AttachedProperty<bool> ShowOnDisabledProperty
TipProperty Field
Defines the ToolTip.Tip attached property.
public Avalonia.AttachedProperty<object> TipProperty
ToolTipClosingEvent Field
The event raised when a ToolTip on an element that was shown should now be hidden.
public Avalonia.Interactivity.RoutedEvent ToolTipClosingEvent
Remarks
Marking the ToolTipClosing event as handled does not cancel closing the tooltip. Once the tooltip is displayed, closing the tooltip is done only in response to user interaction with the UI.
ToolTipOpeningEvent Field
The event raised when a ToolTip is going to be shown on an element.
public Avalonia.Interactivity.RoutedEvent<Avalonia.Interactivity.CancelRoutedEventArgs> ToolTipOpeningEvent
Remarks
To prevent a tooltip from appearing in the UI, your handler for ToolTipOpening can mark the event data handled. Otherwise, the tooltip is displayed, using the value of the ToolTip property as the tooltip content. Another possible scenario is that you could write a handler that resets the value of the ToolTip property for the element that is the event source, just before the tooltip is displayed. ToolTipOpening will not be raised if the value of ToolTip is null or otherwise unset. Do not deliberately set ToolTip to null while a tooltip is open or opening; this will not have the effect of closing the tooltip, and will instead create an undesirable visual artifact in the UI.
VerticalOffsetProperty Field
Defines the ToolTip.VerticalOffset property.
public Avalonia.AttachedProperty<double> VerticalOffsetProperty
Events
| Name | Description |
|---|---|
| ActualThemeVariantChanged | Raised when the theme variant is changed on the element or an ancestor of the element. Inherited from StyledElement. |
| AttachedToLogicalTree | Raised when the styled element is attached to a rooted logical tree. Inherited from StyledElement. |
| AttachedToVisualTree | Raised when the control is attached to a rooted visual tree. Inherited from Visual. |
| ContextCanceled | Occurs when the context input gesture continues into another gesture, to notify the element that the context flyout should not be opened. Inherited from InputElement. |
| ContextRequested | Occurs when the user has completed a context input gesture, such as a right-click. Inherited from InputElement. |
| DataContextChanged | Occurs when the Avalonia.StyledElement.DataContext property changes. Inherited from StyledElement. |
| DetachedFromLogicalTree | Raised when the styled element is detached from a rooted logical tree. Inherited from StyledElement. |
| DetachedFromVisualTree | Raised when the control is detached from a rooted visual tree. Inherited from Visual. |
| DoubleTapped | Occurs when the user briefly contacts and releases twice on a single point, without significant movement. Inherited from InputElement. |
| EffectiveViewportChanged | Occurs when the element's effective viewport changes. Inherited from Layoutable. |
| GettingFocus | Occurs before the control receives focus. Inherited from InputElement. |
| GotFocus | Occurs when the control receives focus. Inherited from InputElement. |
| Holding | Occurs when the user makes a single contact, then maintains contact beyond a given time threshold without releasing or making another contact. Inherited from InputElement. |
| Initialized | Occurs when the styled element has finished initialization. Inherited from StyledElement. |
| KeyDown | Occurs when a key is pressed while the control has focus. Inherited from InputElement. |
| KeyUp | Occurs when a key is released while the control has focus. Inherited from InputElement. |
| LayoutUpdated | Occurs when a layout pass completes for the control. 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. |
| LosingFocus | Occurs before the control loses focus. Inherited from InputElement. |
| LostFocus | Occurs when the control loses focus. Inherited from InputElement. |
| Pinch | Occurs when the user moves two contact points closer together. Inherited from InputElement. |
| PinchEnded | Occurs when the user releases both contact points used in a pinch gesture. Inherited from InputElement. |
| PointerCaptureLost | Occurs when the control or its child control loses the pointer capture for any reason, event will not be triggered for a parent control if capture was transferred to another child of that parent control. Inherited from InputElement. |
| PointerEntered | Occurs when the pointer enters the control. Inherited from InputElement. |
| PointerExited | Occurs when the pointer leaves the control. Inherited from InputElement. |
| PointerMoved | Occurs when the pointer moves over the control. Inherited from InputElement. |
| PointerPressed | Occurs when the pointer is pressed over the control. Inherited from InputElement. |
| PointerReleased | Occurs when the pointer is released over the control. Inherited from InputElement. |
| PointerTouchPadGestureMagnify | Occurs when the user moves two contact points away from each other on a touchpad. Inherited from InputElement. |
| PointerTouchPadGestureRotate | Occurs when the user places two contact points and moves them in a circular motion on a touchpad. Inherited from InputElement. |
| PointerTouchPadGestureSwipe | Occurs when the user performs a rapid dragging motion in a single direction on a touchpad. Inherited from InputElement. |
| PointerWheelChanged | Occurs when the mouse is scrolled over the control. Inherited from InputElement. |
| PropertyChanged | Raised when a Avalonia.AvaloniaProperty value changes on this object. Inherited from AvaloniaObject. |
| PullGesture | Occurs when the user drags from the edge of a control. Inherited from InputElement. |
| PullGestureEnded | Occurs when the user releases the pointer after a pull gesture. Inherited from InputElement. |
| ResourcesChanged | Occurs when a resource in this styled element or a parent styled element has changed. Inherited from StyledElement. |
| RightTapped | Occurs when the user briefly contacts and releases a single point, without significant movement, using a mechanism on the input device recognized as a right button or equivalent. Inherited from InputElement. |
| ScrollGesture | Occurs when the user continuously moves the pointer in the same direction within the control’s boundaries. Inherited from InputElement. |
| ScrollGestureEnded | Occurs when a scroll gesture has fully stopped, taking into account any inertial movement that continues the scroll after the user has released the pointer. Inherited from InputElement. |
| ScrollGestureInertiaStarting | Occurs within a scroll gesture, when the user releases the pointer, and scrolling continues by transitioning to momentum-based gliding movement. Inherited from InputElement. |
| SizeChanged | Occurs when the bounds (actual size) of the control have changed. Inherited from Control. |
| SwipeGesture | Occurs when the user rapidly drags the pointer in a single direction across the control. Inherited from InputElement. |
| SwipeGestureEnded | Occurs when a swipe gesture ends on the control. Inherited from InputElement. |
| Tapped | Occurs when the user briefly contacts and releases a single point, without significant movement. Inherited from InputElement. |
| TemplateApplied | Raised when the control's template is applied. Inherited from TemplatedControl. |
| TextInput | Occurs when a user typed some text while the control has focus. Inherited from InputElement. |
| TextInputMethodClientRequested | Occurs when an input element gains input focus and input method is looking for the corresponding client Inherited from InputElement. |
| Unloaded | Occurs when the control is removed from the visual tree. Inherited from Control. |