Skip to main content

InputElement Class

Definition​

Namespace:Avalonia.Input
Assembly:Avalonia.Base
Package:Avalonia

Implements input-related functionality for a control.

public class InputElement

Inheritance: object -> AvaloniaObject -> Animatable -> StyledElement -> Visual -> Layoutable -> Interactive -> InputElement

Derived types: Control, DocumentNode

Implements:IInputElement

Constructors​

NameDescription
InputElementNo summary available.

InputElement Constructor​

public InputElement()

Methods​

NameDescription
AddHandler (2 overloads)Adds a handler for the specified routed event. Inherited from Interactive.
ApplyStylingApplies styling to the control if the control is initialized and styling is not already applied. Inherited from StyledElement.
ApplyTemplateCreates the visual children of the control, if necessary Inherited from Layoutable.
ArrangeArranges the control and its children. Inherited from Layoutable.
BeginInitInherited 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.
EndInitInherited from StyledElement.
EqualsCompares two objects using reference equality. Inherited from AvaloniaObject.
FocusFocuses the control.
GetBaseValueInherited from AvaloniaObject.
GetFlowDirectionGets the value of the attached Avalonia.Visual.FlowDirectionProperty on a control. Inherited from Visual.
GetHashCodeGets the hash code for the object. Inherited from AvaloniaObject.
GetIsHoldingEnabledNo summary available.
GetIsHoldWithMouseEnabledNo summary available.
GetValue (3 overloads)Gets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject.
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.
InvalidateVisualInvalidates the visual and queues a repaint. Inherited from Visual.
IsAnimatingChecks whether a Avalonia.AvaloniaProperty is animating. Inherited from AvaloniaObject.
IsSetChecks whether a Avalonia.AvaloniaProperty is set on this object. Inherited from AvaloniaObject.
MeasureCarries out a measure of the control. Inherited from Layoutable.
RaiseEventRaises a routed event. Inherited from Interactive.
RemoveHandler (2 overloads)Removes a handler for the specified routed event. Inherited from Interactive.
RenderRenders the visual to a Avalonia.Media.DrawingContext. Inherited from Visual.
SetCurrentValue (2 overloads)Sets the value of a dependency property without changing its value source. Inherited from AvaloniaObject.
SetFlowDirectionSets the value of the attached Avalonia.Visual.FlowDirectionProperty on a control. Inherited from Visual.
SetIsHoldingEnabledNo summary available.
SetIsHoldWithMouseEnabledNo summary available.
SetValue (3 overloads)Sets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject.
TryGetResourceInherited from StyledElement.
UpdateLayoutExecutes a layout pass. Inherited from Layoutable.
VerifyAccessChecks that the current thread is the UI thread and throws if not. Inherited from AvaloniaObject.

Focus Method​

Focuses the control.

public bool Focus(Avalonia.Input.NavigationMethod method, Avalonia.Input.KeyModifiers keyModifiers)

Parameters​

method Avalonia.Input.NavigationMethod

The method by which focus was changed.

keyModifiers Avalonia.Input.KeyModifiers

Any key modifiers active at the time of focus.

Returns​

bool

GetIsHoldingEnabled Method​

public bool GetIsHoldingEnabled(Avalonia.StyledElement element)

Parameters​

element Avalonia.StyledElement

Returns​

bool

GetIsHoldWithMouseEnabled Method​

public bool GetIsHoldWithMouseEnabled(Avalonia.StyledElement element)

Parameters​

element Avalonia.StyledElement

Returns​

bool

SetIsHoldingEnabled Method​

public void SetIsHoldingEnabled(Avalonia.StyledElement element, bool value)

Parameters​

element Avalonia.StyledElement

value bool

SetIsHoldWithMouseEnabled Method​

public void SetIsHoldWithMouseEnabled(Avalonia.StyledElement element, bool value)

Parameters​

element Avalonia.StyledElement

value bool

Properties​

NameDescription
ActualThemeVariantGets the UI theme that is currently used by the element, which might be different than the RequestedThemeVariantProperty. Inherited from StyledElement.
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.
ClassesGets or sets the styled element's classes. Inherited from StyledElement.
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.
CursorGets or sets associated mouse cursor.
DataContextGets or sets the control's data context. Inherited from StyledElement.
DesiredSizeGets the size that this element computed during the measure pass of the layout process. Inherited from Layoutable.
DispatcherReturns the Avalonia.AvaloniaObject.Dispatcher that this Avalonia.AvaloniaObject is associated with. Inherited from AvaloniaObject.
EffectGets or sets the effect of the control. Inherited from Visual.
FlowDirectionGets or sets the text flow direction. Inherited from Visual.
FocusableGets or sets a value indicating whether the control can receive focus.
GestureRecognizersNo summary available.
HasMirrorTransformGets or sets a value indicating whether to apply mirror transform on this control. Inherited from Visual.
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.
IsEffectivelyEnabledGets a value indicating whether this control and all its parents are enabled.
IsEffectivelyVisibleGets a value indicating whether this control and all its parents are visible. Inherited from Visual.
IsEnabledGets or sets a value indicating whether the control is enabled for user interaction.
IsFocusedGets a value indicating whether the control is focused.
IsHitTestVisibleGets or sets a value indicating whether the control is considered for hit testing.
IsInitializedGets a value that indicates whether the element has finished initialization. Inherited from StyledElement.
IsKeyboardFocusWithinGets a value indicating whether keyboard focus is anywhere within the element or its visual tree child elements.
IsMeasureValidGets a value indicating whether the control's layout measure is valid. Inherited from Layoutable.
IsPointerOverGets a value indicating whether the pointer is currently over the control.
IsTabStopGets or sets a value that indicates whether the control is included in tab navigation.
IsVisibleGets or sets a value indicating whether this control is visible. Inherited from Visual.
ItemInherited from AvaloniaObject.
KeyBindingsNo summary available.
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.
NameGets or sets the name of the styled element. Inherited from StyledElement.
OpacityGets or sets the opacity of the control. Inherited from Visual.
OpacityMaskGets or sets the opacity mask of the control. Inherited from Visual.
ParentGets the styled element's logical parent. Inherited from StyledElement.
RenderTransformGets or sets the render transform of the control. Inherited from Visual.
RenderTransformOriginGets or sets the transform origin of the control. Inherited from Visual.
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.
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.
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.
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.
ZIndexGets or sets the Z index of the control. Inherited from Visual.

Cursor Property​

Gets or sets associated mouse cursor.

public Avalonia.Input.Cursor Cursor { get; set; }

Focusable Property​

Gets or sets a value indicating whether the control can receive focus.

public bool Focusable { get; set; }

GestureRecognizers Property​

public Avalonia.Input.GestureRecognizers.GestureRecognizerCollection GestureRecognizers { get; set; }

IsEffectivelyEnabled Property​

Gets a value indicating whether this control and all its parents are enabled.

public bool IsEffectivelyEnabled { get; set; }

Remarks​

The Avalonia.Input.IInputElement.IsEnabled property is used to toggle the enabled state for individual controls. The Avalonia.Input.IInputElement.IsEffectivelyEnabled property takes into account the Avalonia.Input.IInputElement.IsEnabled value of this control and its parent controls.

IsEnabled Property​

Gets or sets a value indicating whether the control is enabled for user interaction.

public bool IsEnabled { get; set; }

IsFocused Property​

Gets a value indicating whether the control is focused.

public bool IsFocused { get; set; }

IsHitTestVisible Property​

Gets or sets a value indicating whether the control is considered for hit testing.

public bool IsHitTestVisible { get; set; }

IsKeyboardFocusWithin Property​

Gets a value indicating whether keyboard focus is anywhere within the element or its visual tree child elements.

public bool IsKeyboardFocusWithin { get; set; }

IsPointerOver Property​

Gets a value indicating whether the pointer is currently over the control.

public bool IsPointerOver { get; set; }

IsTabStop Property​

Gets or sets a value that indicates whether the control is included in tab navigation.

public bool IsTabStop { get; set; }

KeyBindings Property​

public System.Collections.Generic.List<Avalonia.Input.KeyBinding> KeyBindings { get; set; }

TabIndex Property​

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.

public int TabIndex { get; set; }

Fields​

NameDescription
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.
ContextCanceledEventProvides event data for the Avalonia.Input.InputElement.ContextCanceled event.
ContextRequestedEventProvides event data for the Avalonia.Input.InputElement.ContextRequested event.
CursorPropertyGets or sets associated mouse cursor.
DataContextPropertyDefines the Avalonia.StyledElement.DataContext property. Inherited from StyledElement.
DesiredSizePropertyDefines the Avalonia.Layout.Layoutable.DesiredSize property. Inherited from Layoutable.
DoubleTappedEventDefines the Avalonia.Input.InputElement.DoubleTapped event.
EffectPropertyDefines the Avalonia.Visual.Effect property. Inherited from Visual.
FlowDirectionPropertyDefines the Avalonia.Visual.FlowDirection property. Inherited from Visual.
FocusablePropertyDefines the Avalonia.Input.InputElement.Focusable property.
GettingFocusEventDefines the Avalonia.Input.InputElement.GettingFocus event.
GotFocusEventDefines the Avalonia.Input.InputElement.GotFocus event.
HasMirrorTransformPropertyDefines the Avalonia.Visual.HasMirrorTransform property. Inherited from Visual.
HeightPropertyDefines the Avalonia.Layout.Layoutable.Height property. Inherited from Layoutable.
HoldingEventDefines the Avalonia.Input.InputElement.Holding event.
HorizontalAlignmentPropertyDefines the Avalonia.Layout.Layoutable.HorizontalAlignment property. Inherited from Layoutable.
IsEffectivelyEnabledPropertyDefines the Avalonia.Input.InputElement.IsEffectivelyEnabled property.
IsEnabledPropertyDefines the Avalonia.Input.InputElement.IsEnabled property.
IsFocusedPropertyDefines the Avalonia.Input.InputElement.IsFocused property.
IsHitTestVisiblePropertyDefines the Avalonia.Input.InputElement.IsHitTestVisible property.
IsHoldingEnabledPropertyDefines the IsHoldingEnabled attached property.
IsHoldWithMouseEnabledPropertyDefines the IsHoldWithMouseEnabled attached property.
IsKeyboardFocusWithinPropertyDefines the Avalonia.Input.InputElement.IsKeyboardFocusWithin property.
IsPointerOverPropertyDefines the Avalonia.Input.InputElement.IsPointerOver property.
IsTabStopPropertyDefines the Avalonia.Input.InputElement.IsTabStop property.
IsVisiblePropertyDefines the Avalonia.Visual.IsVisible property. Inherited from Visual.
KeyDownEventDefines the Avalonia.Input.InputElement.KeyDown event.
KeyUpEventDefines the Avalonia.Input.InputElement.KeyUp event.
LosingFocusEventDefines the Avalonia.Input.InputElement.LosingFocus event.
LostFocusEventDefines the Avalonia.Input.InputElement.LostFocus event.
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.
NamePropertyDefines the Avalonia.StyledElement.Name property. Inherited from StyledElement.
OpacityMaskPropertyDefines the Avalonia.Visual.OpacityMask property. Inherited from Visual.
OpacityPropertyDefines the Avalonia.Visual.Opacity property. Inherited from Visual.
ParentPropertyDefines the Avalonia.StyledElement.Parent property. Inherited from StyledElement.
PinchEndedEventDefines the Avalonia.Input.InputElement.PinchEnded event.
PinchEventDefines the Avalonia.Input.InputElement.Pinch event.
PointerCaptureLostEventDefines the Avalonia.Input.InputElement.PointerCaptureLost routed event.
PointerEnteredEventDefines the Avalonia.Input.InputElement.PointerEntered event.
PointerExitedEventDefines the Avalonia.Input.InputElement.PointerExited event.
PointerMovedEventDefines the Avalonia.Input.InputElement.PointerMoved event.
PointerPressedEventDefines the Avalonia.Input.InputElement.PointerPressed event.
PointerReleasedEventDefines the Avalonia.Input.InputElement.PointerReleased event.
PointerTouchPadGestureMagnifyEventDefines the Avalonia.Input.InputElement.PointerTouchPadGestureMagnify event.
PointerTouchPadGestureRotateEventDefines the Avalonia.Input.InputElement.PointerTouchPadGestureRotate event.
PointerTouchPadGestureSwipeEventDefines the Avalonia.Input.InputElement.PointerTouchPadGestureSwipe event.
PointerWheelChangedEventDefines the Avalonia.Input.InputElement.PointerWheelChanged event.
PullGestureEndedEventDefines the Avalonia.Input.InputElement.PullGestureEnded event.
PullGestureEventDefines the Avalonia.Input.InputElement.PullGesture event.
RenderTransformOriginPropertyDefines the Avalonia.Visual.RenderTransformOrigin property. Inherited from Visual.
RenderTransformPropertyDefines the Avalonia.Visual.RenderTransform property. Inherited from Visual.
RightTappedEventDefines the Avalonia.Input.InputElement.RightTapped event.
ScrollGestureEndedEventDefines the Avalonia.Input.InputElement.ScrollGestureEnded event.
ScrollGestureEventDefines the Avalonia.Input.InputElement.ScrollGesture event.
ScrollGestureInertiaStartingEventDefines the Avalonia.Input.InputElement.ScrollGestureInertiaStarting event.
SwipeGestureEndedEventDefines the Avalonia.Input.InputElement.SwipeGestureEnded event.
SwipeGestureEventDefines the Avalonia.Input.InputElement.SwipeGesture event.
TabIndexPropertyDefines the Avalonia.Input.InputElement.TabIndex property.
TappedEventDefines the Avalonia.Input.InputElement.Tapped event.
TemplatedParentPropertyDefines the Avalonia.StyledElement.TemplatedParent property. Inherited from StyledElement.
TextInputEventDefines the Avalonia.Input.InputElement.TextInput event.
TextInputMethodClientRequestedEventDefines the Avalonia.Input.InputElement.TextInputMethodClientRequested event.
ThemePropertyDefines the Avalonia.StyledElement.Theme property. Inherited from StyledElement.
TransitionsPropertyDefines the Avalonia.Animation.Animatable.Transitions property. Inherited from Animatable.
UseLayoutRoundingPropertyDefines the Avalonia.Layout.Layoutable.UseLayoutRounding property. Inherited from Layoutable.
VerticalAlignmentPropertyDefines the Avalonia.Layout.Layoutable.VerticalAlignment property. Inherited from Layoutable.
VisualParentPropertyDefines the Avalonia.Visual.VisualParent property. Inherited from Visual.
WidthPropertyDefines the Avalonia.Layout.Layoutable.Width property. Inherited from Layoutable.
ZIndexPropertyDefines the Avalonia.Visual.ZIndex property. Inherited from Visual.

ContextCanceledEvent Field​

Provides event data for the Avalonia.Input.InputElement.ContextCanceled event.

public Avalonia.Interactivity.RoutedEvent<TEventArgs><Avalonia.Interactivity.RoutedEventArgs> ContextCanceledEvent

ContextRequestedEvent Field​

Provides event data for the Avalonia.Input.InputElement.ContextRequested event.

public Avalonia.Interactivity.RoutedEvent<TEventArgs><Avalonia.Input.ContextRequestedEventArgs> ContextRequestedEvent

CursorProperty Field​

Gets or sets associated mouse cursor.

public Avalonia.StyledProperty<TValue><Avalonia.Input.Cursor> CursorProperty

DoubleTappedEvent Field​

Defines the Avalonia.Input.InputElement.DoubleTapped event.

public Avalonia.Interactivity.RoutedEvent<TEventArgs><Avalonia.Input.TappedEventArgs> DoubleTappedEvent

FocusableProperty Field​

Defines the Avalonia.Input.InputElement.Focusable property.

public Avalonia.StyledProperty<TValue><bool> FocusableProperty

GettingFocusEvent Field​

Defines the Avalonia.Input.InputElement.GettingFocus event.

public Avalonia.Interactivity.RoutedEvent<TEventArgs><Avalonia.Input.FocusChangingEventArgs> GettingFocusEvent

GotFocusEvent Field​

Defines the Avalonia.Input.InputElement.GotFocus event.

public Avalonia.Interactivity.RoutedEvent<TEventArgs><Avalonia.Input.FocusChangedEventArgs> GotFocusEvent

HoldingEvent Field​

Defines the Avalonia.Input.InputElement.Holding event.

public Avalonia.Interactivity.RoutedEvent<TEventArgs><Avalonia.Input.HoldingRoutedEventArgs> HoldingEvent

IsEffectivelyEnabledProperty Field​

Defines the Avalonia.Input.InputElement.IsEffectivelyEnabled property.

public Avalonia.DirectProperty<TOwner,TValue><Avalonia.Input.InputElement, bool> IsEffectivelyEnabledProperty

IsEnabledProperty Field​

Defines the Avalonia.Input.InputElement.IsEnabled property.

public Avalonia.StyledProperty<TValue><bool> IsEnabledProperty

IsFocusedProperty Field​

Defines the Avalonia.Input.InputElement.IsFocused property.

public Avalonia.DirectProperty<TOwner,TValue><Avalonia.Input.InputElement, bool> IsFocusedProperty

IsHitTestVisibleProperty Field​

Defines the Avalonia.Input.InputElement.IsHitTestVisible property.

public Avalonia.StyledProperty<TValue><bool> IsHitTestVisibleProperty

IsHoldingEnabledProperty Field​

Defines the IsHoldingEnabled attached property.

public Avalonia.AttachedProperty<TValue><bool> IsHoldingEnabledProperty

IsHoldWithMouseEnabledProperty Field​

Defines the IsHoldWithMouseEnabled attached property.

public Avalonia.AttachedProperty<TValue><bool> IsHoldWithMouseEnabledProperty

IsKeyboardFocusWithinProperty Field​

Defines the Avalonia.Input.InputElement.IsKeyboardFocusWithin property.

public Avalonia.DirectProperty<TOwner,TValue><Avalonia.Input.InputElement, bool> IsKeyboardFocusWithinProperty

IsPointerOverProperty Field​

Defines the Avalonia.Input.InputElement.IsPointerOver property.

public Avalonia.DirectProperty<TOwner,TValue><Avalonia.Input.InputElement, bool> IsPointerOverProperty

IsTabStopProperty Field​

Defines the Avalonia.Input.InputElement.IsTabStop property.

public Avalonia.StyledProperty<TValue><bool> IsTabStopProperty

KeyDownEvent Field​

Defines the Avalonia.Input.InputElement.KeyDown event.

public Avalonia.Interactivity.RoutedEvent<TEventArgs><Avalonia.Input.KeyEventArgs> KeyDownEvent

KeyUpEvent Field​

Defines the Avalonia.Input.InputElement.KeyUp event.

public Avalonia.Interactivity.RoutedEvent<TEventArgs><Avalonia.Input.KeyEventArgs> KeyUpEvent

LosingFocusEvent Field​

Defines the Avalonia.Input.InputElement.LosingFocus event.

public Avalonia.Interactivity.RoutedEvent<TEventArgs><Avalonia.Input.FocusChangingEventArgs> LosingFocusEvent

LostFocusEvent Field​

Defines the Avalonia.Input.InputElement.LostFocus event.

public Avalonia.Interactivity.RoutedEvent<TEventArgs><Avalonia.Input.FocusChangedEventArgs> LostFocusEvent

PinchEndedEvent Field​

Defines the Avalonia.Input.InputElement.PinchEnded event.

public Avalonia.Interactivity.RoutedEvent<TEventArgs><Avalonia.Input.PinchEndedEventArgs> PinchEndedEvent

PinchEvent Field​

Defines the Avalonia.Input.InputElement.Pinch event.

public Avalonia.Interactivity.RoutedEvent<TEventArgs><Avalonia.Input.PinchEventArgs> PinchEvent

PointerCaptureLostEvent Field​

Defines the Avalonia.Input.InputElement.PointerCaptureLost routed event.

public Avalonia.Interactivity.RoutedEvent<TEventArgs><Avalonia.Input.PointerCaptureLostEventArgs> PointerCaptureLostEvent

PointerEnteredEvent Field​

Defines the Avalonia.Input.InputElement.PointerEntered event.

public Avalonia.Interactivity.RoutedEvent<TEventArgs><Avalonia.Input.PointerEventArgs> PointerEnteredEvent

PointerExitedEvent Field​

Defines the Avalonia.Input.InputElement.PointerExited event.

public Avalonia.Interactivity.RoutedEvent<TEventArgs><Avalonia.Input.PointerEventArgs> PointerExitedEvent

PointerMovedEvent Field​

Defines the Avalonia.Input.InputElement.PointerMoved event.

public Avalonia.Interactivity.RoutedEvent<TEventArgs><Avalonia.Input.PointerEventArgs> PointerMovedEvent

PointerPressedEvent Field​

Defines the Avalonia.Input.InputElement.PointerPressed event.

public Avalonia.Interactivity.RoutedEvent<TEventArgs><Avalonia.Input.PointerPressedEventArgs> PointerPressedEvent

PointerReleasedEvent Field​

Defines the Avalonia.Input.InputElement.PointerReleased event.

public Avalonia.Interactivity.RoutedEvent<TEventArgs><Avalonia.Input.PointerReleasedEventArgs> PointerReleasedEvent

PointerTouchPadGestureMagnifyEvent Field​

Defines the Avalonia.Input.InputElement.PointerTouchPadGestureMagnify event.

public Avalonia.Interactivity.RoutedEvent<TEventArgs><Avalonia.Input.PointerDeltaEventArgs> PointerTouchPadGestureMagnifyEvent

PointerTouchPadGestureRotateEvent Field​

Defines the Avalonia.Input.InputElement.PointerTouchPadGestureRotate event.

public Avalonia.Interactivity.RoutedEvent<TEventArgs><Avalonia.Input.PointerDeltaEventArgs> PointerTouchPadGestureRotateEvent

PointerTouchPadGestureSwipeEvent Field​

Defines the Avalonia.Input.InputElement.PointerTouchPadGestureSwipe event.

public Avalonia.Interactivity.RoutedEvent<TEventArgs><Avalonia.Input.PointerDeltaEventArgs> PointerTouchPadGestureSwipeEvent

PointerWheelChangedEvent Field​

Defines the Avalonia.Input.InputElement.PointerWheelChanged event.

public Avalonia.Interactivity.RoutedEvent<TEventArgs><Avalonia.Input.PointerWheelEventArgs> PointerWheelChangedEvent

PullGestureEndedEvent Field​

Defines the Avalonia.Input.InputElement.PullGestureEnded event.

public Avalonia.Interactivity.RoutedEvent<TEventArgs><Avalonia.Input.PullGestureEndedEventArgs> PullGestureEndedEvent

PullGestureEvent Field​

Defines the Avalonia.Input.InputElement.PullGesture event.

public Avalonia.Interactivity.RoutedEvent<TEventArgs><Avalonia.Input.PullGestureEventArgs> PullGestureEvent

RightTappedEvent Field​

Defines the Avalonia.Input.InputElement.RightTapped event.

public Avalonia.Interactivity.RoutedEvent<TEventArgs><Avalonia.Input.TappedEventArgs> RightTappedEvent

ScrollGestureEndedEvent Field​

Defines the Avalonia.Input.InputElement.ScrollGestureEnded event.

public Avalonia.Interactivity.RoutedEvent<TEventArgs><Avalonia.Input.ScrollGestureEndedEventArgs> ScrollGestureEndedEvent

ScrollGestureEvent Field​

Defines the Avalonia.Input.InputElement.ScrollGesture event.

public Avalonia.Interactivity.RoutedEvent<TEventArgs><Avalonia.Input.ScrollGestureEventArgs> ScrollGestureEvent

ScrollGestureInertiaStartingEvent Field​

Defines the Avalonia.Input.InputElement.ScrollGestureInertiaStarting event.

public Avalonia.Interactivity.RoutedEvent<TEventArgs><Avalonia.Input.ScrollGestureInertiaStartingEventArgs> ScrollGestureInertiaStartingEvent

SwipeGestureEndedEvent Field​

Defines the Avalonia.Input.InputElement.SwipeGestureEnded event.

public Avalonia.Interactivity.RoutedEvent<TEventArgs><Avalonia.Input.SwipeGestureEndedEventArgs> SwipeGestureEndedEvent

SwipeGestureEvent Field​

Defines the Avalonia.Input.InputElement.SwipeGesture event.

public Avalonia.Interactivity.RoutedEvent<TEventArgs><Avalonia.Input.SwipeGestureEventArgs> SwipeGestureEvent

TabIndexProperty Field​

Defines the Avalonia.Input.InputElement.TabIndex property.

public Avalonia.StyledProperty<TValue><int> TabIndexProperty

TappedEvent Field​

Defines the Avalonia.Input.InputElement.Tapped event.

public Avalonia.Interactivity.RoutedEvent<TEventArgs><Avalonia.Input.TappedEventArgs> TappedEvent

TextInputEvent Field​

Defines the Avalonia.Input.InputElement.TextInput event.

public Avalonia.Interactivity.RoutedEvent<TEventArgs><Avalonia.Input.TextInputEventArgs> TextInputEvent

TextInputMethodClientRequestedEvent Field​

Defines the Avalonia.Input.InputElement.TextInputMethodClientRequested event.

public Avalonia.Interactivity.RoutedEvent<TEventArgs><Avalonia.Input.TextInput.TextInputMethodClientRequestedEventArgs> TextInputMethodClientRequestedEvent

Events​

NameDescription
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.
AttachedToVisualTreeRaised when the control is attached to a rooted visual tree. Inherited from Visual.
ContextCanceledOccurs when the context input gesture continues into another gesture, to notify the element that the context flyout should not be opened.
ContextRequestedOccurs when the user has completed a context input gesture, such as a right-click.
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.
DetachedFromVisualTreeRaised when the control is detached from a rooted visual tree. Inherited from Visual.
DoubleTappedOccurs when the user briefly contacts and releases twice on a single point, without significant movement.
EffectiveViewportChangedOccurs when the element's effective viewport changes. Inherited from Layoutable.
GettingFocusOccurs before the control receives focus.
GotFocusOccurs when the control receives focus.
HoldingOccurs when the user makes a single contact, then maintains contact beyond a given time threshold without releasing or making another contact.
InitializedOccurs when the styled element has finished initialization. Inherited from StyledElement.
KeyDownOccurs when a key is pressed while the control has focus.
KeyUpOccurs when a key is released while the control has focus.
LayoutUpdatedOccurs when a layout pass completes for the control. Inherited from Layoutable.
LosingFocusOccurs before the control loses focus.
LostFocusOccurs when the control loses focus.
PinchOccurs when the user moves two contact points closer together.
PinchEndedOccurs when the user releases both contact points used in a pinch gesture.
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.
PointerEnteredOccurs when the pointer enters the control.
PointerExitedOccurs when the pointer leaves the control.
PointerMovedOccurs when the pointer moves over the control.
PointerPressedOccurs when the pointer is pressed over the control.
PointerReleasedOccurs when the pointer is released over the control.
PointerTouchPadGestureMagnifyOccurs when the user moves two contact points away from each other on a touchpad.
PointerTouchPadGestureRotateOccurs when the user places two contact points and moves them in a circular motion on a touchpad.
PointerTouchPadGestureSwipeOccurs when the user performs a rapid dragging motion in a single direction on a touchpad.
PointerWheelChangedOccurs when the mouse is scrolled over the control.
PropertyChangedRaised when a Avalonia.AvaloniaProperty value changes on this object. Inherited from AvaloniaObject.
PullGestureOccurs when the user drags from the edge of a control.
PullGestureEndedOccurs when the user releases the pointer after a pull gesture.
ResourcesChangedOccurs when a resource in this styled element or a parent styled element has changed. Inherited from StyledElement.
RightTappedOccurs 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.
ScrollGestureOccurs when the user continuously moves the pointer in the same direction within the control’s boundaries.
ScrollGestureEndedOccurs when a scroll gesture has fully stopped, taking into account any inertial movement that continues the scroll after the user has released the pointer.
ScrollGestureInertiaStartingOccurs within a scroll gesture, when the user releases the pointer, and scrolling continues by transitioning to momentum-based gliding movement.
SwipeGestureOccurs when the user rapidly drags the pointer in a single direction across the control.
SwipeGestureEndedOccurs when a swipe gesture ends on the control.
TappedOccurs when the user briefly contacts and releases a single point, without significant movement.
TextInputOccurs when a user typed some text while the control has focus.
TextInputMethodClientRequestedOccurs when an input element gains input focus and input method is looking for the corresponding client

ContextCanceled Event​

Occurs when the context input gesture continues into another gesture, to notify the element that the context flyout should not be opened.

public event EventHandler<Avalonia.Interactivity.RoutedEventArgs> ContextCanceled

ContextRequested Event​

Occurs when the user has completed a context input gesture, such as a right-click.

public event EventHandler<Avalonia.Input.ContextRequestedEventArgs> ContextRequested

DoubleTapped Event​

Occurs when the user briefly contacts and releases twice on a single point, without significant movement.

public event EventHandler<Avalonia.Input.TappedEventArgs> DoubleTapped

GettingFocus Event​

Occurs before the control receives focus.

public event EventHandler<Avalonia.Input.FocusChangingEventArgs> GettingFocus

GotFocus Event​

Occurs when the control receives focus.

public event EventHandler<Avalonia.Input.FocusChangedEventArgs> GotFocus

Holding Event​

Occurs when the user makes a single contact, then maintains contact beyond a given time threshold without releasing or making another contact.

public event EventHandler<Avalonia.Input.HoldingRoutedEventArgs> Holding

KeyDown Event​

Occurs when a key is pressed while the control has focus.

public event EventHandler<Avalonia.Input.KeyEventArgs> KeyDown

KeyUp Event​

Occurs when a key is released while the control has focus.

public event EventHandler<Avalonia.Input.KeyEventArgs> KeyUp

LosingFocus Event​

Occurs before the control loses focus.

public event EventHandler<Avalonia.Input.FocusChangingEventArgs> LosingFocus

LostFocus Event​

Occurs when the control loses focus.

public event EventHandler<Avalonia.Input.FocusChangedEventArgs> LostFocus

Pinch Event​

Occurs when the user moves two contact points closer together.

public event EventHandler<Avalonia.Input.PinchEventArgs> Pinch

PinchEnded Event​

Occurs when the user releases both contact points used in a pinch gesture.

public event EventHandler<Avalonia.Input.PinchEndedEventArgs> PinchEnded

PointerCaptureLost Event​

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.

public event EventHandler<Avalonia.Input.PointerCaptureLostEventArgs> PointerCaptureLost

PointerEntered Event​

Occurs when the pointer enters the control.

public event EventHandler<Avalonia.Input.PointerEventArgs> PointerEntered

PointerExited Event​

Occurs when the pointer leaves the control.

public event EventHandler<Avalonia.Input.PointerEventArgs> PointerExited

PointerMoved Event​

Occurs when the pointer moves over the control.

public event EventHandler<Avalonia.Input.PointerEventArgs> PointerMoved

PointerPressed Event​

Occurs when the pointer is pressed over the control.

public event EventHandler<Avalonia.Input.PointerPressedEventArgs> PointerPressed

PointerReleased Event​

Occurs when the pointer is released over the control.

public event EventHandler<Avalonia.Input.PointerReleasedEventArgs> PointerReleased

PointerTouchPadGestureMagnify Event​

Occurs when the user moves two contact points away from each other on a touchpad.

public event EventHandler<Avalonia.Input.PointerDeltaEventArgs> PointerTouchPadGestureMagnify

PointerTouchPadGestureRotate Event​

Occurs when the user places two contact points and moves them in a circular motion on a touchpad.

public event EventHandler<Avalonia.Input.PointerDeltaEventArgs> PointerTouchPadGestureRotate

PointerTouchPadGestureSwipe Event​

Occurs when the user performs a rapid dragging motion in a single direction on a touchpad.

public event EventHandler<Avalonia.Input.PointerDeltaEventArgs> PointerTouchPadGestureSwipe

PointerWheelChanged Event​

Occurs when the mouse is scrolled over the control.

public event EventHandler<Avalonia.Input.PointerWheelEventArgs> PointerWheelChanged

PullGesture Event​

Occurs when the user drags from the edge of a control.

public event EventHandler<Avalonia.Input.PullGestureEventArgs> PullGesture

PullGestureEnded Event​

Occurs when the user releases the pointer after a pull gesture.

public event EventHandler<Avalonia.Input.PullGestureEndedEventArgs> PullGestureEnded

RightTapped Event​

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.

public event EventHandler<Avalonia.Input.TappedEventArgs> RightTapped

ScrollGesture Event​

Occurs when the user continuously moves the pointer in the same direction within the control’s boundaries.

public event EventHandler<Avalonia.Input.ScrollGestureEventArgs> ScrollGesture

ScrollGestureEnded Event​

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.

public event EventHandler<Avalonia.Input.ScrollGestureEndedEventArgs> ScrollGestureEnded

ScrollGestureInertiaStarting Event​

Occurs within a scroll gesture, when the user releases the pointer, and scrolling continues by transitioning to momentum-based gliding movement.

public event EventHandler<Avalonia.Input.ScrollGestureInertiaStartingEventArgs> ScrollGestureInertiaStarting

SwipeGesture Event​

Occurs when the user rapidly drags the pointer in a single direction across the control.

public event EventHandler<Avalonia.Input.SwipeGestureEventArgs> SwipeGesture

SwipeGestureEnded Event​

Occurs when a swipe gesture ends on the control.

public event EventHandler<Avalonia.Input.SwipeGestureEndedEventArgs> SwipeGestureEnded

Tapped Event​

Occurs when the user briefly contacts and releases a single point, without significant movement.

public event EventHandler<Avalonia.Input.TappedEventArgs> Tapped

TextInput Event​

Occurs when a user typed some text while the control has focus.

public event EventHandler<Avalonia.Input.TextInputEventArgs> TextInput

TextInputMethodClientRequested Event​

Occurs when an input element gains input focus and input method is looking for the corresponding client

public event EventHandler<Avalonia.Input.TextInput.TextInputMethodClientRequestedEventArgs> TextInputMethodClientRequested

On this page