Skip to main content

ToolTip Class

Definition

Assembly:Avalonia.Controls
Package:Avalonia
Source:ToolTip.cs

A control which pops up a hint when a control is hovered.

public class ToolTip

Implements: IPopupHostProvider

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

NameDescription
ToolTipNo summary available.

ToolTip Constructor

public ToolTip()

Methods

NameDescription
AddToolTipClosingHandlerNo summary available.
AddToolTipOpeningHandlerNo summary available.
GetBetweenShowDelayGets 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.
GetCustomPopupPlacementCallbackGets the value of the ToolTip.CustomPopupPlacementCallback attached property.
GetHorizontalOffsetGets the value of the ToolTip.HorizontalOffset attached property.
GetIsOpenGets the value of the ToolTip.IsOpen attached property.
GetPlacementGets the value of the ToolTip.Placement attached property.
GetServiceEnabledGets whether showing and hiding of a control's tooltip will be automatically controlled by Avalonia.
GetShowDelayGets the value of the ToolTip.ShowDelay attached property.
GetShowOnDisabledGets whether a control will display a tooltip even if it disabled.
GetTipGets the value of the ToolTip.Tip attached property.
GetVerticalOffsetGets the value of the ToolTip.VerticalOffset attached property.
RemoveToolTipClosingHandlerNo summary available.
RemoveToolTipOpeningHandlerNo summary available.
SetBetweenShowDelaySets the number of milliseconds since the last tooltip closed during which the tooltip of element will open immediately.
SetCustomPopupPlacementCallbackSets the value of the ToolTip.CustomPopupPlacementCallback attached property.
SetHorizontalOffsetSets the value of the ToolTip.HorizontalOffset attached property.
SetIsOpenSets the value of the ToolTip.IsOpen attached property.
SetPlacementSets the value of the ToolTip.Placement attached property.
SetServiceEnabledSets whether showing and hiding of a control's tooltip will be automatically controlled by Avalonia.
SetShowDelaySets the value of the ToolTip.ShowDelay attached property.
SetShowOnDisabledSets whether a control will display a tooltip even if it disabled.
SetTipSets the value of the ToolTip.Tip attached property.
SetVerticalOffsetSets the value of the ToolTip.VerticalOffset attached property.
ApplyTemplateCreates the visual children of the control, if necessary Inherited from TemplatedControl.
GetIsTemplateFocusTargetGets the value of the IsTemplateFocusTargetProperty attached property on a control. Inherited from TemplatedControl.
SetIsTemplateFocusTargetSets the value of the IsTemplateFocusTargetProperty attached property on a control. Inherited from TemplatedControl.
FocusFocuses the control. Inherited from InputElement.
GetIsHoldWithMouseEnabledInherited from InputElement.
GetIsHoldingEnabledInherited from InputElement.
SetIsHoldWithMouseEnabledInherited from InputElement.
SetIsHoldingEnabledInherited from InputElement.
AddHandler (2 overloads)Adds a handler for the specified routed event. Inherited from Interactive.
RaiseEventRaises a routed event. Inherited from Interactive.
RemoveHandler (2 overloads)Removes a handler for the specified routed event. Inherited from Interactive.
ArrangeArranges the control and its children. Inherited from Layoutable.
InvalidateArrangeInvalidates the arrangement of the control and queues a new layout pass. Inherited from Layoutable.
InvalidateMeasureInvalidates the measurement of the control and queues a new layout pass. Inherited from Layoutable.
MeasureCarries out a measure of the control. Inherited from Layoutable.
UpdateLayoutExecutes a layout pass. Inherited from Layoutable.
GetFlowDirectionGets the value of the attached Avalonia.Visual.FlowDirectionProperty on a control. Inherited from Visual.
InvalidateVisualInvalidates the visual and queues a repaint. Inherited from Visual.
RenderRenders the visual to a Avalonia.Media.DrawingContext. Inherited from Visual.
SetFlowDirectionSets the value of the attached Avalonia.Visual.FlowDirectionProperty on a control. Inherited from Visual.
ApplyStylingApplies styling to the control if the control is initialized and styling is not already applied. Inherited from StyledElement.
BeginInitInherited from StyledElement.
EndInitInherited from StyledElement.
TryGetResourceInherited from StyledElement.
Bind (8 overloads)Binds a Avalonia.AvaloniaProperty to an Avalonia.Data.BindingBase. Inherited from AvaloniaObject.
CheckAccessReturns 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.
CoerceValueCoerces the specified Avalonia.AvaloniaProperty. Inherited from AvaloniaObject.
EqualsCompares two objects using reference equality. Inherited from AvaloniaObject.
GetBaseValueInherited from AvaloniaObject.
GetHashCodeGets the hash code for the object. Inherited from AvaloniaObject.
GetValue (3 overloads)Gets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject.
IsAnimatingChecks whether a Avalonia.AvaloniaProperty is animating. Inherited from AvaloniaObject.
IsSetChecks whether a Avalonia.AvaloniaProperty is set on this object. Inherited from AvaloniaObject.
SetCurrentValue (2 overloads)Sets the value of a dependency property without changing its value source. Inherited from AvaloniaObject.
SetValue (3 overloads)Sets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject.
VerifyAccessChecks 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

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.

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

NameDescription
ContentGets or sets the content to display. Inherited from ContentControl.
ContentTemplateGets or sets the data template used to display the content of the control. Inherited from ContentControl.
HorizontalContentAlignmentGets or sets the horizontal alignment of the content within the control. Inherited from ContentControl.
PresenterGets the presenter from the control's template. Inherited from ContentControl.
VerticalContentAlignmentGets or sets the vertical alignment of the content within the control. Inherited from ContentControl.
BackgroundGets or sets the brush used to draw the control's background. Inherited from TemplatedControl.
BackgroundSizingGets or sets how the control's background is drawn relative to the control's border. Inherited from TemplatedControl.
BorderBrushGets or sets the brush used to draw the control's border. Inherited from TemplatedControl.
BorderThicknessGets or sets the thickness of the control's border. Inherited from TemplatedControl.
CornerRadiusGets or sets the radius of the border rounded corners. Inherited from TemplatedControl.
FontFamilyGets or sets the font family used to draw the control's text. Inherited from TemplatedControl.
FontFeaturesGets or sets the font features turned on/off. Inherited from TemplatedControl.
FontSizeGets or sets the size of the control's text in points. Inherited from TemplatedControl.
FontStretchGets or sets the font stretch used to draw the control's text. Inherited from TemplatedControl.
FontStyleGets or sets the font style used to draw the control's text. Inherited from TemplatedControl.
FontWeightGets or sets the font weight used to draw the control's text. Inherited from TemplatedControl.
ForegroundGets or sets the brush used to draw the control's text and other foreground elements. Inherited from TemplatedControl.
LetterSpacingGets or sets the letter spacing for the control's text content. Inherited from TemplatedControl.
PaddingGets or sets the padding placed between the border of the control and its content. Inherited from TemplatedControl.
TemplateGets or sets the template that defines the control's appearance. Inherited from TemplatedControl.
ContextFlyoutGets or sets a context flyout to the control Inherited from Control.
ContextMenuGets or sets a context menu to the control. Inherited from Control.
DataTemplatesGets or sets the data templates for the control. Inherited from Control.
FocusAdornerGets or sets the control's focus adorner. Inherited from Control.
IsLoadedGets a value indicating whether the control is fully constructed in the visual tree and both layout and render are complete. Inherited from Control.
TagGets or sets a user-defined object attached to the control. Inherited from Control.
CursorGets or sets associated mouse cursor. Inherited from InputElement.
FocusableGets or sets a value indicating whether the control can receive focus. Inherited from InputElement.
GestureRecognizersInherited from InputElement.
IsEffectivelyEnabledGets a value indicating whether this control and all its parents are enabled. Inherited from InputElement.
IsEnabledGets or sets a value indicating whether the control is enabled for user interaction. Inherited from InputElement.
IsFocusedGets a value indicating whether the control is focused. Inherited from InputElement.
IsHitTestVisibleGets or sets a value indicating whether the control is considered for hit testing. Inherited from InputElement.
IsKeyboardFocusWithinGets a value indicating whether keyboard focus is anywhere within the element or its visual tree child elements. Inherited from InputElement.
IsPointerOverGets a value indicating whether the pointer is currently over the control. Inherited from InputElement.
IsTabStopGets or sets a value that indicates whether the control is included in tab navigation. Inherited from InputElement.
KeyBindingsInherited from InputElement.
TabIndexGets 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.
DesiredSizeGets the size that this element computed during the measure pass of the layout process. Inherited from Layoutable.
HeightGets or sets the height of the element. Inherited from Layoutable.
HorizontalAlignmentGets or sets the element's preferred horizontal alignment in its parent. Inherited from Layoutable.
IsArrangeValidGets a value indicating whether the control's layouts arrange is valid. Inherited from Layoutable.
IsMeasureValidGets a value indicating whether the control's layout measure is valid. Inherited from Layoutable.
MarginGets or sets the margin around the element. Inherited from Layoutable.
MaxHeightGets or sets the maximum height of the element. Inherited from Layoutable.
MaxWidthGets or sets the maximum width of the element. Inherited from Layoutable.
MinHeightGets or sets the minimum height of the element. Inherited from Layoutable.
MinWidthGets or sets the minimum width of the element. Inherited from Layoutable.
UseLayoutRoundingGets or sets a value that determines whether the element should be snapped to pixel boundaries at layout time. Inherited from Layoutable.
VerticalAlignmentGets or sets the element's preferred vertical alignment in its parent. Inherited from Layoutable.
WidthGets or sets the width of the element. Inherited from Layoutable.
BoundsGets the bounds of the control relative to its parent. Inherited from Visual.
CacheModeGets or sets the cache mode of the visual. Inherited from Visual.
ClipGets or sets the geometry clip for this visual. Inherited from Visual.
ClipToBoundsGets or sets a value indicating whether the control should be clipped to its bounds. Inherited from Visual.
EffectGets or sets the effect of the control. Inherited from Visual.
FlowDirectionGets or sets the text flow direction. Inherited from Visual.
HasMirrorTransformGets or sets a value indicating whether to apply mirror transform on this control. Inherited from Visual.
IsEffectivelyVisibleGets a value indicating whether this control and all its parents are visible. Inherited from Visual.
IsVisibleGets or sets a value indicating whether this control is visible. Inherited from Visual.
OpacityGets or sets the opacity of the control. Inherited from Visual.
OpacityMaskGets or sets the opacity mask of the control. Inherited from Visual.
RenderTransformGets or sets the render transform of the control. Inherited from Visual.
RenderTransformOriginGets or sets the transform origin of the control. Inherited from Visual.
ZIndexGets or sets the Z index of the control. Inherited from Visual.
ActualThemeVariantGets the UI theme that is currently used by the element, which might be different than the RequestedThemeVariantProperty. Inherited from StyledElement.
ClassesGets or sets the styled element's classes. Inherited from StyledElement.
DataContextGets or sets the control's data context. Inherited from StyledElement.
IsInitializedGets a value that indicates whether the element has finished initialization. Inherited from StyledElement.
NameGets or sets the name of the styled element. Inherited from StyledElement.
ParentGets the styled element's logical parent. Inherited from StyledElement.
ResourcesGets or sets the styled element's resource dictionary. Inherited from StyledElement.
StyleKeyGets the type by which the element is styled. Inherited from StyledElement.
StylesGets the styles for the styled element. Inherited from StyledElement.
TemplatedParentGets the styled element whose lookless template this styled element is part of. Inherited from StyledElement.
ThemeGets or sets the theme to be applied to the element. Inherited from StyledElement.
TransitionsGets or sets the property transitions for the control. Inherited from Animatable.
DispatcherReturns the Avalonia.AvaloniaObject.Dispatcher that this Avalonia.AvaloniaObject is associated with. Inherited from AvaloniaObject.
ItemInherited from AvaloniaObject.

Fields

NameDescription
BetweenShowDelayPropertyDefines the ToolTip.BetweenShowDelay property.
CustomPopupPlacementCallbackPropertyDefines the Avalonia.Controls.Primitives.Popup.CustomPopupPlacementCallback property.
HorizontalOffsetPropertyDefines the ToolTip.HorizontalOffset property.
IsOpenPropertyDefines the ToolTip.IsOpen attached property.
PlacementPropertyDefines the ToolTip.Placement property.
ServiceEnabledPropertyDefines the ToolTip.ServiceEnabled property.
ShowDelayPropertyDefines the ToolTip.ShowDelay property.
ShowOnDisabledPropertyDefines the ToolTip.ShowOnDisabled property.
TipPropertyDefines the ToolTip.Tip attached property.
ToolTipClosingEventThe event raised when a ToolTip on an element that was shown should now be hidden.
ToolTipOpeningEventThe event raised when a ToolTip is going to be shown on an element.
VerticalOffsetPropertyDefines the ToolTip.VerticalOffset property.
ContentPropertyDefines the Avalonia.Controls.ContentControl.Content property. Inherited from ContentControl.
ContentTemplatePropertyDefines the Avalonia.Controls.ContentControl.ContentTemplate property. Inherited from ContentControl.
HorizontalContentAlignmentPropertyDefines the Avalonia.Controls.ContentControl.HorizontalContentAlignment property. Inherited from ContentControl.
VerticalContentAlignmentPropertyDefines the Avalonia.Controls.ContentControl.VerticalContentAlignment property. Inherited from ContentControl.
BackgroundPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.Background property. Inherited from TemplatedControl.
BackgroundSizingPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.BackgroundSizing property. Inherited from TemplatedControl.
BorderBrushPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.BorderBrush property. Inherited from TemplatedControl.
BorderThicknessPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.BorderThickness property. Inherited from TemplatedControl.
CornerRadiusPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.CornerRadius property. Inherited from TemplatedControl.
FontFamilyPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.FontFamily property. Inherited from TemplatedControl.
FontFeaturesPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.FontFeaturesProperty property. Inherited from TemplatedControl.
FontSizePropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.FontSize property. Inherited from TemplatedControl.
FontStretchPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.FontWeight property. Inherited from TemplatedControl.
FontStylePropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.FontStyle property. Inherited from TemplatedControl.
FontWeightPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.FontWeight property. Inherited from TemplatedControl.
ForegroundPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.Foreground property. Inherited from TemplatedControl.
IsTemplateFocusTargetPropertyDefines the IsTemplateFocusTarget attached property. Inherited from TemplatedControl.
LetterSpacingPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.LetterSpacing property. Inherited from TemplatedControl.
PaddingPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.Padding property. Inherited from TemplatedControl.
TemplateAppliedEventDefines the Avalonia.Controls.Primitives.TemplatedControl.TemplateApplied routed event. Inherited from TemplatedControl.
TemplatePropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.Template property. Inherited from TemplatedControl.
ContextFlyoutPropertyDefines the Avalonia.Controls.Control.ContextFlyout property Inherited from Control.
ContextMenuPropertyDefines the Avalonia.Controls.Control.ContextMenu property. Inherited from Control.
FocusAdornerPropertyDefines the Avalonia.Controls.Control.FocusAdorner property. Inherited from Control.
LoadedEventDefines the Avalonia.Controls.Control.Loaded event. Inherited from Control.
RequestBringIntoViewEventEvent raised when an element wishes to be scrolled into view. Inherited from Control.
SizeChangedEventDefines the Avalonia.Controls.Control.SizeChanged event. Inherited from Control.
TagPropertyDefines the Avalonia.Controls.Control.Tag property. Inherited from Control.
UnloadedEventDefines the Avalonia.Controls.Control.Unloaded event. Inherited from Control.
ContextCanceledEventProvides event data for the Avalonia.Input.InputElement.ContextCanceled event. Inherited from InputElement.
ContextRequestedEventProvides event data for the Avalonia.Input.InputElement.ContextRequested event. Inherited from InputElement.
CursorPropertyGets or sets associated mouse cursor. Inherited from InputElement.
DoubleTappedEventDefines the Avalonia.Input.InputElement.DoubleTapped event. Inherited from InputElement.
FocusablePropertyDefines the Avalonia.Input.InputElement.Focusable property. Inherited from InputElement.
GettingFocusEventDefines the Avalonia.Input.InputElement.GettingFocus event. Inherited from InputElement.
GotFocusEventDefines the Avalonia.Input.InputElement.GotFocus event. Inherited from InputElement.
HoldingEventDefines the Avalonia.Input.InputElement.Holding event. Inherited from InputElement.
IsEffectivelyEnabledPropertyDefines the Avalonia.Input.InputElement.IsEffectivelyEnabled property. Inherited from InputElement.
IsEnabledPropertyDefines the Avalonia.Input.InputElement.IsEnabled property. Inherited from InputElement.
IsFocusedPropertyDefines the Avalonia.Input.InputElement.IsFocused property. Inherited from InputElement.
IsHitTestVisiblePropertyDefines the Avalonia.Input.InputElement.IsHitTestVisible property. Inherited from InputElement.
IsHoldWithMouseEnabledPropertyDefines the IsHoldWithMouseEnabled attached property. Inherited from InputElement.
IsHoldingEnabledPropertyDefines the IsHoldingEnabled attached property. Inherited from InputElement.
IsKeyboardFocusWithinPropertyDefines the Avalonia.Input.InputElement.IsKeyboardFocusWithin property. Inherited from InputElement.
IsPointerOverPropertyDefines the Avalonia.Input.InputElement.IsPointerOver property. Inherited from InputElement.
IsTabStopPropertyDefines the Avalonia.Input.InputElement.IsTabStop property. Inherited from InputElement.
KeyDownEventDefines the Avalonia.Input.InputElement.KeyDown event. Inherited from InputElement.
KeyUpEventDefines the Avalonia.Input.InputElement.KeyUp event. Inherited from InputElement.
LosingFocusEventDefines the Avalonia.Input.InputElement.LosingFocus event. Inherited from InputElement.
LostFocusEventDefines the Avalonia.Input.InputElement.LostFocus event. Inherited from InputElement.
PinchEndedEventDefines the Avalonia.Input.InputElement.PinchEnded event. Inherited from InputElement.
PinchEventDefines the Avalonia.Input.InputElement.Pinch event. Inherited from InputElement.
PointerCaptureLostEventDefines the Avalonia.Input.InputElement.PointerCaptureLost routed event. Inherited from InputElement.
PointerEnteredEventDefines the Avalonia.Input.InputElement.PointerEntered event. Inherited from InputElement.
PointerExitedEventDefines the Avalonia.Input.InputElement.PointerExited event. Inherited from InputElement.
PointerMovedEventDefines the Avalonia.Input.InputElement.PointerMoved event. Inherited from InputElement.
PointerPressedEventDefines the Avalonia.Input.InputElement.PointerPressed event. Inherited from InputElement.
PointerReleasedEventDefines the Avalonia.Input.InputElement.PointerReleased event. Inherited from InputElement.
PointerTouchPadGestureMagnifyEventDefines the Avalonia.Input.InputElement.PointerTouchPadGestureMagnify event. Inherited from InputElement.
PointerTouchPadGestureRotateEventDefines the Avalonia.Input.InputElement.PointerTouchPadGestureRotate event. Inherited from InputElement.
PointerTouchPadGestureSwipeEventDefines the Avalonia.Input.InputElement.PointerTouchPadGestureSwipe event. Inherited from InputElement.
PointerWheelChangedEventDefines the Avalonia.Input.InputElement.PointerWheelChanged event. Inherited from InputElement.
PullGestureEndedEventDefines the Avalonia.Input.InputElement.PullGestureEnded event. Inherited from InputElement.
PullGestureEventDefines the Avalonia.Input.InputElement.PullGesture event. Inherited from InputElement.
RightTappedEventDefines the Avalonia.Input.InputElement.RightTapped event. Inherited from InputElement.
ScrollGestureEndedEventDefines the Avalonia.Input.InputElement.ScrollGestureEnded event. Inherited from InputElement.
ScrollGestureEventDefines the Avalonia.Input.InputElement.ScrollGesture event. Inherited from InputElement.
ScrollGestureInertiaStartingEventDefines the Avalonia.Input.InputElement.ScrollGestureInertiaStarting event. Inherited from InputElement.
SwipeGestureEventDefines the Avalonia.Input.InputElement.SwipeGesture event. Inherited from InputElement.
TabIndexPropertyDefines the Avalonia.Input.InputElement.TabIndex property. Inherited from InputElement.
TappedEventDefines the Avalonia.Input.InputElement.Tapped event. Inherited from InputElement.
TextInputEventDefines the Avalonia.Input.InputElement.TextInput event. Inherited from InputElement.
TextInputMethodClientRequestedEventDefines the Avalonia.Input.InputElement.TextInputMethodClientRequested event. Inherited from InputElement.
DesiredSizePropertyDefines the Avalonia.Layout.Layoutable.DesiredSize property. Inherited from Layoutable.
HeightPropertyDefines the Avalonia.Layout.Layoutable.Height property. Inherited from Layoutable.
HorizontalAlignmentPropertyDefines the Avalonia.Layout.Layoutable.HorizontalAlignment property. Inherited from Layoutable.
MarginPropertyDefines the Avalonia.Layout.Layoutable.Margin property. Inherited from Layoutable.
MaxHeightPropertyDefines the Avalonia.Layout.Layoutable.MaxHeight property. Inherited from Layoutable.
MaxWidthPropertyDefines the Avalonia.Layout.Layoutable.MaxWidth property. Inherited from Layoutable.
MinHeightPropertyDefines the Avalonia.Layout.Layoutable.MinHeight property. Inherited from Layoutable.
MinWidthPropertyDefines the Avalonia.Layout.Layoutable.MinWidth property. Inherited from Layoutable.
UseLayoutRoundingPropertyDefines the Avalonia.Layout.Layoutable.UseLayoutRounding property. Inherited from Layoutable.
VerticalAlignmentPropertyDefines the Avalonia.Layout.Layoutable.VerticalAlignment property. Inherited from Layoutable.
WidthPropertyDefines the Avalonia.Layout.Layoutable.Width property. Inherited from Layoutable.
BoundsPropertyDefines the Avalonia.Visual.Bounds property. Inherited from Visual.
CacheModePropertyDefines the Avalonia.Visual.CacheMode property. Inherited from Visual.
ClipPropertyDefines the Avalonia.Visual.Clip property. Inherited from Visual.
ClipToBoundsPropertyDefines the Avalonia.Visual.ClipToBounds property. Inherited from Visual.
EffectPropertyDefines the Avalonia.Visual.Effect property. Inherited from Visual.
FlowDirectionPropertyDefines the Avalonia.Visual.FlowDirection property. Inherited from Visual.
HasMirrorTransformPropertyDefines the Avalonia.Visual.HasMirrorTransform property. Inherited from Visual.
IsVisiblePropertyDefines the Avalonia.Visual.IsVisible property. Inherited from Visual.
OpacityMaskPropertyDefines the Avalonia.Visual.OpacityMask property. Inherited from Visual.
OpacityPropertyDefines the Avalonia.Visual.Opacity property. Inherited from Visual.
RenderTransformOriginPropertyDefines the Avalonia.Visual.RenderTransformOrigin property. Inherited from Visual.
RenderTransformPropertyDefines the Avalonia.Visual.RenderTransform property. Inherited from Visual.
VisualParentPropertyDefines the Avalonia.Visual.VisualParent property. Inherited from Visual.
ZIndexPropertyDefines the Avalonia.Visual.ZIndex property. Inherited from Visual.
DataContextPropertyDefines the Avalonia.StyledElement.DataContext property. Inherited from StyledElement.
NamePropertyDefines the Avalonia.StyledElement.Name property. Inherited from StyledElement.
ParentPropertyDefines the Avalonia.StyledElement.Parent property. Inherited from StyledElement.
TemplatedParentPropertyDefines the Avalonia.StyledElement.TemplatedParent property. Inherited from StyledElement.
ThemePropertyDefines the Avalonia.StyledElement.Theme property. Inherited from StyledElement.
TransitionsPropertyDefines the Avalonia.Animation.Animatable.Transitions property. Inherited from Animatable.

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

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

NameDescription
TemplateAppliedRaised when the control's template is applied. Inherited from TemplatedControl.
LoadedOccurs when the control has been fully constructed in the visual tree and both layout and render are complete. Inherited from Control.
SizeChangedOccurs when the bounds (actual size) of the control have changed. Inherited from Control.
UnloadedOccurs when the control is removed from the visual tree. Inherited from Control.
ContextCanceledOccurs when the context input gesture continues into another gesture, to notify the element that the context flyout should not be opened. Inherited from InputElement.
ContextRequestedOccurs when the user has completed a context input gesture, such as a right-click. Inherited from InputElement.
DoubleTappedOccurs when a double-tap gesture occurs on the control. Inherited from InputElement.
GettingFocusOccurs before the control receives focus. Inherited from InputElement.
GotFocusOccurs when the control receives focus. Inherited from InputElement.
HoldingOccurs when a hold gesture occurs on the control. Inherited from InputElement.
KeyDownOccurs when a key is pressed while the control has focus. Inherited from InputElement.
KeyUpOccurs when a key is released while the control has focus. Inherited from InputElement.
LosingFocusOccurs before the control loses focus. Inherited from InputElement.
LostFocusOccurs when the control loses focus. Inherited from InputElement.
PinchOccurs when a pinch gesture occurs on the control. Inherited from InputElement.
PinchEndedOccurs when a pinch gesture ends on the control. Inherited from InputElement.
PointerCaptureLostOccurs 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.
PointerEnteredOccurs when the pointer enters the control. Inherited from InputElement.
PointerExitedOccurs when the pointer leaves the control. Inherited from InputElement.
PointerMovedOccurs when the pointer moves over the control. Inherited from InputElement.
PointerPressedOccurs when the pointer is pressed over the control. Inherited from InputElement.
PointerReleasedOccurs when the pointer is released over the control. Inherited from InputElement.
PointerTouchPadGestureMagnifyOccurs when a touchpad magnify gesture occurs on the control. Inherited from InputElement.
PointerTouchPadGestureRotateOccurs when a touchpad rotate gesture occurs on the control. Inherited from InputElement.
PointerTouchPadGestureSwipeOccurs when a touchpad swipe gesture occurs on the control. Inherited from InputElement.
PointerWheelChangedOccurs when the mouse is scrolled over the control. Inherited from InputElement.
PullGestureOccurs when a pull gesture occurs on the control. Inherited from InputElement.
PullGestureEndedOccurs when a pull gesture ends on the control. Inherited from InputElement.
RightTappedOccurs when a right tap gesture occurs on the control. Inherited from InputElement.
ScrollGestureOccurs when a scroll gesture occurs on the control. Inherited from InputElement.
ScrollGestureEndedOccurs when a scroll gesture ends on the control. Inherited from InputElement.
ScrollGestureInertiaStartingOccurs when a scroll gesture inertia starts on the control. Inherited from InputElement.
SwipeGestureOccurs when a swipe gesture occurs on the control. Inherited from InputElement.
TappedOccurs when a tap gesture occurs on the control. Inherited from InputElement.
TextInputOccurs when a user typed some text while the control has focus. Inherited from InputElement.
TextInputMethodClientRequestedOccurs when an input element gains input focus and input method is looking for the corresponding client Inherited from InputElement.
EffectiveViewportChangedOccurs when the element's effective viewport changes. Inherited from Layoutable.
LayoutUpdatedOccurs when a layout pass completes for the control. Inherited from Layoutable.
AttachedToVisualTreeRaised when the control is attached to a rooted visual tree. Inherited from Visual.
DetachedFromVisualTreeRaised when the control is detached from a rooted visual tree. Inherited from Visual.
ActualThemeVariantChangedRaised when the theme variant is changed on the element or an ancestor of the element. Inherited from StyledElement.
AttachedToLogicalTreeRaised when the styled element is attached to a rooted logical tree. Inherited from StyledElement.
DataContextChangedOccurs when the Avalonia.StyledElement.DataContext property changes. Inherited from StyledElement.
DetachedFromLogicalTreeRaised when the styled element is detached from a rooted logical tree. Inherited from StyledElement.
InitializedOccurs when the styled element has finished initialization. Inherited from StyledElement.
ResourcesChangedOccurs when a resource in this styled element or a parent styled element has changed. Inherited from StyledElement.
PropertyChangedRaised when a Avalonia.AvaloniaProperty value changes on this object. Inherited from AvaloniaObject.