Avalonia API Reference
Input
Implements input-related functionality for a control.
Definition
Namespace: Avalonia.Input
Assembly: Avalonia.Base (in Avalonia.Base.dll) Version: 11.3.999
Assembly: Avalonia.Base (in Avalonia.Base.dll) Version: 11.3.999
C#
[PseudoClassesAttribute(new string[] { ... })]
public class InputElement : Interactive,
IInputElementVB
<PseudoClassesAttribute(New String() { ... })>
Public Class InputElement
Inherits Interactive
Implements IInputElementF#
[<PseudoClassesAttribute(new string[] { ... })>]
type InputElement =
class
inherit Interactive
interface IInputElement
end- Inheritance
- Object AvaloniaObject Animatable StyledElement Visual Layoutable Interactive InputElement
- Derived
- Implements
- IInputElement
Properties
| ActualThemeVariant |
Gets the UI theme that is currently used by the element, which might be different than the RequestedThemeVariantProperty.
(Inherited from StyledElement) |
| Bounds |
Gets the bounds of the control relative to its parent.
(Inherited from Visual) |
| BypassFlowDirectionPolicies |
Gets a value indicating whether control bypass FlowDirecton policies.
(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) |
| Cursor | Gets or sets associated mouse cursor. |
| DataContext |
Gets or sets the control's data context.
(Inherited from StyledElement) |
| DesiredSize |
Gets the size that this element computed during the measure pass of the layout process.
(Inherited from Layoutable) |
| 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. |
| GestureRecognizers | |
| 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) |
| InheritanceParent |
Gets or sets the parent object that inherited AvaloniaProperty values
are inherited from.
(Inherited from AvaloniaObject) |
| 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. |
| 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. |
| IsEnabledCore | Allows a derived class to override the enabled state of the control. |
| IsFocused | Gets a value indicating whether the control is focused. |
| IsHitTestVisible | Gets or sets a value indicating whether the control is considered for hit testing. |
| 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. |
| 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. |
| IsTabStop | Gets or sets a value that indicates whether the control is included in tab navigation. |
| IsVisible |
Gets or sets a value indicating whether this control is visible.
(Inherited from Visual) |
| ItemAvaloniaProperty |
Gets or sets the value of a AvaloniaProperty.
(Inherited from AvaloniaObject) |
| ItemIndexerDescriptor |
Gets or sets a binding for a AvaloniaProperty.
(Inherited from AvaloniaObject) |
| KeyBindings | |
| LogicalChildren |
Gets the styled element's logical children.
(Inherited from StyledElement) |
| 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) |
| Parent |
Gets the styled element's logical parent.
(Inherited from StyledElement) |
| PseudoClasses |
Gets the Classes collection in a form that allows adding and removing
pseudoclasses.
(Inherited from StyledElement) |
| 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) |
| StyleKeyOverride |
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. |
| 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) |
| VisualChildren |
Gets the control's child visuals.
(Inherited from Visual) |
| VisualRoot |
Gets the root of the visual tree, if the control is attached to a visual tree.
(Inherited from Visual) |
| 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) |
Methods
| AddHandler(RoutedEvent, Delegate, RoutingStrategies, Boolean) |
Adds a handler for the specified routed event.
(Inherited from Interactive) |
| AddHandlerTEventArgs(RoutedEventTEventArgs, EventHandlerTEventArgs, RoutingStrategies, Boolean) |
Adds a handler for the specified routed event.
(Inherited from Interactive) |
| 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 Layoutable) |
| Arrange(Rect) |
Arranges the control and its children.
(Inherited from Layoutable) |
| ArrangeCore(Rect) |
The default implementation of the control's arrange pass.
(Inherited from Layoutable) |
| ArrangeOverride(Size) |
Positions child elements as part of a layout pass.
(Inherited from Layoutable) |
| BeginInit | Signals the object that initialization is starting. (Inherited from StyledElement) |
| Bind(AvaloniaProperty, IBinding) |
Binds a AvaloniaProperty to an IBinding.
(Inherited from AvaloniaObject) |
| Bind(AvaloniaProperty, IObservableObject, BindingPriority) |
Binds a AvaloniaProperty to an observable.
(Inherited from AvaloniaObject) |
| BindT(DirectPropertyBaseT, IObservableT) |
Binds a AvaloniaProperty to an observable.
(Inherited from AvaloniaObject) |
| BindT(DirectPropertyBaseT, IObservableBindingValueT) |
Binds a AvaloniaProperty to an observable.
(Inherited from AvaloniaObject) |
| BindT(DirectPropertyBaseT, IObservableObject) |
Binds a AvaloniaProperty to an observable.
(Inherited from AvaloniaObject) |
| BindT(StyledPropertyT, IObservableT, BindingPriority) |
Binds a AvaloniaProperty to an observable.
(Inherited from AvaloniaObject) |
| BindT(StyledPropertyT, IObservableBindingValueT, BindingPriority) |
Binds a AvaloniaProperty to an observable.
(Inherited from AvaloniaObject) |
| BindT(StyledPropertyT, IObservableObject, BindingPriority) |
Binds a AvaloniaProperty to an observable.
(Inherited from AvaloniaObject) |
| BuildEventRoute(RoutedEvent) |
Builds an event route for a routed event.
(Inherited from Interactive) |
| CheckAccess |
Returns a value indicating whether the current thread is the UI thread.
(Inherited from AvaloniaObject) |
| ClearValue(AvaloniaProperty) |
Clears a AvaloniaProperty's local value.
(Inherited from AvaloniaObject) |
| ClearValueT(AvaloniaPropertyT) |
Clears a AvaloniaProperty's local value.
(Inherited from AvaloniaObject) |
| ClearValueT(DirectPropertyBaseT) |
Clears a AvaloniaProperty's local value.
(Inherited from AvaloniaObject) |
| ClearValueT(StyledPropertyT) |
Clears a AvaloniaProperty's local value.
(Inherited from AvaloniaObject) |
| CoerceValue(AvaloniaProperty) |
Coerces the specified AvaloniaProperty.
(Inherited from AvaloniaObject) |
| EndInit | Signals the object that initialization is complete. (Inherited from StyledElement) |
| Equals(Object) |
Compares two objects using reference equality.
(Inherited from AvaloniaObject) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| Focus(NavigationMethod, KeyModifiers) | Focuses the control. |
| GetBaseValueT(StyledPropertyT) |
Gets an AvaloniaProperty base value.
(Inherited from AvaloniaObject) |
| GetHashCode |
Gets the hash code for the object.
(Inherited from AvaloniaObject) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| GetValue(AvaloniaProperty) |
Gets a AvaloniaProperty value.
(Inherited from AvaloniaObject) |
| GetValueT(DirectPropertyBaseT) |
Gets a AvaloniaProperty value.
(Inherited from AvaloniaObject) |
| GetValueT(StyledPropertyT) |
Gets a AvaloniaProperty value.
(Inherited from AvaloniaObject) |
| InitializeIfNeeded | (Inherited from StyledElement) |
| 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) |
| InvalidateMirrorTransform |
Computes the HasMirrorTransform value according to the
FlowDirection and BypassFlowDirectionPolicies (Inherited from Visual) |
| InvalidateVisual |
Invalidates the visual and queues a repaint.
(Inherited from Visual) |
| IsAnimating(AvaloniaProperty) |
Checks whether a AvaloniaProperty is animating.
(Inherited from AvaloniaObject) |
| IsSet(AvaloniaProperty) |
Checks whether a AvaloniaProperty is set on this object.
(Inherited from AvaloniaObject) |
| LogicalChildrenCollectionChanged(Object, NotifyCollectionChangedEventArgs) | (Inherited from Visual) |
| Measure(Size) |
Carries out a measure of the control.
(Inherited from Layoutable) |
| MeasureCore(Size) |
The default implementation of the control's measure pass.
(Inherited from Layoutable) |
| MeasureOverride(Size) |
Measures the control and its child elements as part of a layout pass.
(Inherited from Layoutable) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| OnAccessKey(RoutedEventArgs) | This method is used to execute the action on an effective IInputElement when a corresponding access key has been invoked. By default, the Focus() method is invoked with the NavigationMethod.Tab to indicate a visual focus adorner. Overwrite this method if other methods or additional functionality is needed when an item should receive the focus. |
| OnAttachedToLogicalTree(LogicalTreeAttachmentEventArgs) |
Called when the styled element is added to a rooted logical tree.
(Inherited from StyledElement) |
| OnAttachedToVisualTree(VisualTreeAttachmentEventArgs) |
Called when the control is added to a rooted visual tree.
(Inherited from Visual) |
| OnAttachedToVisualTreeCore(VisualTreeAttachmentEventArgs) |
Calls the OnAttachedToVisualTree(VisualTreeAttachmentEventArgs) method
for this control and all of its visual descendants.
(Overrides LayoutableOnAttachedToVisualTreeCore(VisualTreeAttachmentEventArgs)) |
| OnDataContextBeginUpdate |
Called when the DataContext begins updating.
(Inherited from StyledElement) |
| OnDataContextChanged(EventArgs) |
Called when the DataContext property changes.
(Inherited from StyledElement) |
| OnDataContextEndUpdate |
Called when the DataContext finishes updating.
(Inherited from StyledElement) |
| OnDetachedFromLogicalTree(LogicalTreeAttachmentEventArgs) |
Called when the styled element is removed from a rooted logical tree.
(Inherited from StyledElement) |
| OnDetachedFromVisualTree(VisualTreeAttachmentEventArgs) |
Called when the control is removed from a rooted visual tree.
(Inherited from Visual) |
| OnDetachedFromVisualTreeCore(VisualTreeAttachmentEventArgs) | (Overrides LayoutableOnDetachedFromVisualTreeCore(VisualTreeAttachmentEventArgs)) |
| OnGotFocus(GotFocusEventArgs) | Called before the GotFocus event occurs. |
| OnInitialized |
Called when the control finishes initialization.
(Inherited from StyledElement) |
| OnKeyDown(KeyEventArgs) | Called before the KeyDown event occurs. |
| OnKeyUp(KeyEventArgs) | Called before the KeyUp event occurs. |
| OnLostFocus(RoutedEventArgs) | Called before the LostFocus event occurs. |
| OnMeasureInvalidated |
Called by InvalidateMeasure
(Inherited from Layoutable) |
| OnPointerCaptureLost(PointerCaptureLostEventArgs) | Called before the PointerCaptureLost event occurs. |
| OnPointerEntered(PointerEventArgs) | Called before the PointerEntered event occurs. |
| OnPointerExited(PointerEventArgs) | Called before the PointerExited event occurs. |
| OnPointerMoved(PointerEventArgs) | Called before the PointerMoved event occurs. |
| OnPointerPressed(PointerPressedEventArgs) | Called before the PointerPressed event occurs. |
| OnPointerReleased(PointerReleasedEventArgs) | Called before the PointerReleased event occurs. |
| OnPointerWheelChanged(PointerWheelEventArgs) | Called before the PointerWheelChanged event occurs. |
| OnPropertyChanged(AvaloniaPropertyChangedEventArgs) | (Overrides LayoutableOnPropertyChanged(AvaloniaPropertyChangedEventArgs)) |
| OnPropertyChangedCore(AvaloniaPropertyChangedEventArgs) | (Inherited from Animatable) |
| OnTextInput(TextInputEventArgs) | Called before the TextInput event occurs. |
| OnVisualParentChanged(Visual, Visual) |
Called when the control's visual parent changes.
(Inherited from Layoutable) |
| RaiseEvent(RoutedEventArgs) |
Raises a routed event.
(Inherited from Interactive) |
| RaisePropertyChangedT(DirectPropertyBaseT, T, T) |
Raises the PropertyChanged event for a direct property.
(Inherited from AvaloniaObject) |
| RemoveHandler(RoutedEvent, Delegate) |
Removes a handler for the specified routed event.
(Inherited from Interactive) |
| RemoveHandlerTEventArgs(RoutedEventTEventArgs, EventHandlerTEventArgs) |
Removes a handler for the specified routed event.
(Inherited from Interactive) |
| Render(DrawingContext) |
Renders the visual to a DrawingContext.
(Inherited from Visual) |
| SetAndRaiseT(DirectPropertyBaseT, T, T) |
Sets the backing field for a direct avalonia property, raising the
PropertyChanged event if the value has changed.
(Inherited from AvaloniaObject) |
| SetCurrentValue(AvaloniaProperty, Object) |
Sets the value of a dependency property without changing its value source.
(Inherited from AvaloniaObject) |
| SetCurrentValueT(StyledPropertyT, T) |
Sets the value of a dependency property without changing its value source.
(Inherited from AvaloniaObject) |
| SetValue(AvaloniaProperty, Object, BindingPriority) |
Sets a AvaloniaProperty value.
(Inherited from AvaloniaObject) |
| SetValueT(DirectPropertyBaseT, T) |
Sets a AvaloniaProperty value.
(Inherited from AvaloniaObject) |
| SetValueT(StyledPropertyT, T, BindingPriority) |
Sets a AvaloniaProperty value.
(Inherited from AvaloniaObject) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| TryGetResource(Object, ThemeVariant, Object) |
Tries to find a resource within the object.
(Inherited from StyledElement) |
| UpdateDataValidation(AvaloniaProperty, BindingValueType, Exception) |
Called to update the validation state for properties for which data validation is
enabled.
(Inherited from AvaloniaObject) |
| UpdateIsEffectivelyEnabled | Updates the IsEffectivelyEnabled property value according to the parent control's enabled state and IsEnabledCore. |
| 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) |
Events
| 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) |
| DataContextChanged |
Occurs when the 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 a double-tap gesture occurs on the control. |
| EffectiveViewportChanged |
Occurs when the element's effective viewport changes.
(Inherited from Layoutable) |
| GotFocus | Occurs when the control receives focus. |
| Holding | Occurs when a hold gesture occurs on the control. |
| Initialized |
Occurs when the styled element has finished initialization.
(Inherited from StyledElement) |
| KeyDown | Occurs when a key is pressed while the control has focus. |
| KeyUp | Occurs when a key is released while the control has focus. |
| LayoutUpdated |
Occurs when a layout pass completes for the control.
(Inherited from Layoutable) |
| LostFocus | Occurs when the control loses focus. |
| 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 |
| PointerEntered | Occurs when the pointer enters the control. |
| PointerExited | Occurs when the pointer leaves the control. |
| PointerMoved | Occurs when the pointer moves over the control. |
| PointerPressed | Occurs when the pointer is pressed over the control. |
| PointerReleased | Occurs when the pointer is released over the control. |
| PointerWheelChanged | Occurs when the mouse is scrolled over the control. |
| PropertyChanged |
Raised when a AvaloniaProperty value changes on this object.
(Inherited from AvaloniaObject) |
| ResourcesChanged |
Occurs when a resource in this styled element or a parent styled element has changed.
(Inherited from StyledElement) |
| Tapped | Occurs when a tap gesture occurs on the control. |
| TextInput | Occurs when a user typed some text while the control has focus. |
| TextInputMethodClientRequested | Occurs when an input element gains input focus and input method is looking for the corresponding client |