Avalonia UI Framework - API - IInputRoot Interface

IInputRoot Interface

Summary

Defines the interface for top-level input elements.
graph TD Interface0["IInputElement"]-.->Type click Interface0 "/api/Avalonia.Input/IInputElement" Interface1["IInteractive"]-.->Type click Interface1 "/api/Avalonia.Interactivity/IInteractive" Interface2["IVisual"]-.->Type click Interface2 "/api/Avalonia.VisualTree/IVisual" Type["IInputRoot"] class Type type-node Type-.->Implementing0["PopupRoot"] click Implementing0 "/api/Avalonia.Controls.Primitives/PopupRoot" Type-.->Implementing1["WindowBase"] click Implementing1 "/api/Avalonia.Controls/WindowBase" Type-.->Implementing2["TopLevel"] click Implementing2 "/api/Avalonia.Controls/TopLevel" Type-.->Implementing3["Window"] click Implementing3 "/api/Avalonia.Controls/Window" Type-.->Implementing4["EmbeddableControlRoot"] click Implementing4 "/api/Avalonia.Controls.Embedding/EmbeddableControlRoot"

Syntax

public interface IInputRoot : IInputElement, IInteractive, IVisual

Properties

Name Value Summary
AccessKeyHandler IAccessKeyHandler
Gets or sets the access key handler.
KeyboardNavigationHandler IKeyboardNavigationHandler
Gets or sets the keyboard navigation handler.
MouseDevice IMouseDevice
Gets associated mouse device
PointerOverElement IInputElement
Gets or sets the input element that the pointer is currently over.
ShowAccessKeys bool
Gets or sets a value indicating whether access keys are shown in the window.

Extension Methods

Name Value Summary
CalculateDistanceFromAncestor(IVisual) int
Calculates the distance from a visual's IRenderRoot.
FindCommonVisualAncestor(IVisual) IVisual
Tries to get the first common ancestor of two visuals.
GetInputElementsAt(Point) IEnumerable<T>
Returns the active input elements at a point on an IInputElement.
GetObservable<TEventArgs>(RoutedEvent<TEventArgs>, RoutingStrategies, bool) IObservable<T>
Gets an observable for a RoutedEvent<TEventArgs>.
GetSelfAndVisualAncestors() IEnumerable<T>
Enumerates an IVisual and its ancestors in the visual tree.
GetSelfAndVisualDescendants() IEnumerable<T>
Enumerates an IVisual and its descendants in the visual tree.
GetVisualAncestors() IEnumerable<T>
Enumerates the ancestors of an IVisual in the visual tree.
GetVisualAt(Point) IVisual
Gets the first visual in the visual tree whose bounds contain a point.
GetVisualChildren() IEnumerable<T>
Enumerates the children of an IVisual in the visual tree.
GetVisualDescendants() IEnumerable<T>
Enumerates the descendants of an IVisual in the visual tree.
GetVisualParent() IVisual
Gets the visual parent of an IVisual.
GetVisualParent<T>() T
Gets the visual parent of an IVisual.
GetVisualRoot() IRenderRoot
Gets the root visual for an IVisual.
GetVisualsAt(Point) IEnumerable<T>
Enumerates the visible visuals in the visual tree whose bounds contain a point.
GetVisualsAt(Point, Func<IVisual, bool>) IEnumerable<T>
Enumerates the visuals in the visual tree whose bounds contain a point.
InputHitTest(Point) IInputElement
Returns the topmost active input element at a point on an IInputElement.
IsVisualAncestorOf(IVisual) bool
Tests whether an IVisual is an ancestor of another visual.
PointToClient(Point) Point
Converts a point from screen to client coordinates.
PointToScreen(Point) Point
Converts a point from client to screen coordinates.
TranslatePoint(Point, IVisual) Point
Translates a point relative to this visual to coordinates that are relative to the specified visual. The visual and relativeTo should be descendants of the same root window