Skip to main content

TopLevel Class

Base class for top-level widgets.

Definition

Namespace: Avalonia.Controls
Assembly: Avalonia.Controls (in Avalonia.Controls.dll)

[TemplatePartAttribute("PART_TransparencyFallback", typeof(Border))]
public abstract class TopLevel : ContentControl,
IInputRoot, IInputElement, ILayoutRoot, IRenderRoot, ICloseable,
IStyleHost, ILogicalRoot, ILogical, ITextInputMethodRoot
View Source
InheritanceObjectAvaloniaObjectAnimatableStyledElementVisualLayoutableInteractiveInputElementControlTemplatedControlContentControl → TopLevel
DerivedAvalonia.Controls.Embedding.EmbeddableControlRoot
Avalonia.Controls.WindowBase
ImplementsICloseable, IInputElement, IInputRoot, ITextInputMethodRoot, ILayoutRoot, ILogical, ILogicalRoot, IRenderRoot, IStyleHost

Remarks

This class acts as a base for top level widget. It handles scheduling layout, styling and rendering as well as tracking the widget's ClientSize.

Properties

ActualThemeVariantGets the UI theme that is currently used by the element, which might be different than the RequestedThemeVariantProperty.
(Inherited from StyledElement)
ActualTransparencyLevelGets the achieved WindowTransparencyLevel that the platform was able to provide.
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)
BoundsGets the bounds of the control relative to its parent.
(Inherited from Visual)
BypassFlowDirectionPolicies
(Overrides Visual.BypassFlowDirectionPolicies)
ClassesGets or sets the styled element's classes.
(Inherited from StyledElement)
ClientSizeGets or sets the client size of the window.
ClipGets or sets the geometry clip for this visual.
(Inherited from Visual)
ClipboardGets the platform's clipboard implementation
ClipToBoundsGets or sets a value indicating whether the control should be clipped to its bounds.
(Inherited from Visual)
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)
ContextFlyoutGets or sets a context flyout to the control
(Inherited from Control)
ContextMenuGets or sets a context menu to the control.
(Inherited from Control)
CornerRadiusGets or sets the radius of the border rounded corners.
(Inherited from TemplatedControl)
CursorGets or sets associated mouse cursor.
(Inherited from InputElement)
DataContextGets or sets the control's data context.
(Inherited from StyledElement)
DataTemplatesGets or sets the data templates for the control.
(Inherited from Control)
DesiredSizeGets the size that this element computed during the measure pass of the layout process.
(Inherited from Layoutable)
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.
(Inherited from InputElement)
FocusAdornerGets or sets the control's focus adorner.
(Inherited from Control)
FocusManagerGets focus manager of the root.
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)
FrameSizeGets or sets the total size of the window.
GestureRecognizers
(Inherited from InputElement)
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)
HorizontalContentAlignmentGets or sets the horizontal alignment of the content within the control.
(Inherited from ContentControl)
InheritanceParentGets or sets the parent object that inherited AvaloniaProperty values are inherited from.
(Inherited from AvaloniaObject)
InputPane 
InsetsManager 
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.
(Inherited from InputElement)
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.
(Inherited from InputElement)
IsEnabledCoreAllows a derived class to override the enabled state of the control.
(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)
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.
(Inherited from InputElement)
IsLoadedGets a value indicating whether the control is fully constructed in the visual tree and both layout and render are complete.
(Inherited from Control)
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.
(Inherited from InputElement)
IsTabStopGets or sets a value that indicates whether the control is included in tab navigation.
(Inherited from InputElement)
IsVisibleGets or sets a value indicating whether this control is visible.
(Inherited from Visual)
Item(AvaloniaProperty)Gets or sets the value of a AvaloniaProperty.
(Inherited from AvaloniaObject)
Item(IndexerDescriptor)Gets or sets a binding for a AvaloniaProperty.
(Inherited from AvaloniaObject)
KeyBindings
(Inherited from InputElement)
Launcher 
LogicalChildrenGets the styled element's logical children.
(Inherited from StyledElement)
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)
PaddingGets or sets the padding placed between the border of the control and its content.
(Inherited from TemplatedControl)
ParentGets the styled element's logical parent.
(Inherited from StyledElement)
PlatformSettingsRepresents a contract for accessing top-level platform-specific settings.
PresenterGets the presenter from the control's template.
(Inherited from ContentControl)
PseudoClassesGets the Classes collection in a form that allows adding and removing pseudoclasses.
(Inherited from StyledElement)
RendererDiagnosticsGets a value indicating whether the renderer should draw specific diagnostics.
RenderScalingThe scaling factor to use in rendering.
RenderTransformGets or sets the render transform of the control.
(Inherited from Visual)
RenderTransformOriginGets or sets the transform origin of the control.
(Inherited from Visual)
RequestedThemeVariantGets or sets the UI theme variant that is used by the control (and its child elements) for resource determination. The UI theme you specify with ThemeVariant can override the app-level ThemeVariant.
ResourcesGets or sets the styled element's resource dictionary.
(Inherited from StyledElement)
ScreensGets platform screens implementation.
StorageProviderFile System storage service used for file pickers and bookmarks.
StyleKeyGets the type by which the element is styled.
(Inherited from StyledElement)
StyleKeyOverrideGets 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.
(Inherited from InputElement)
TagGets or sets a user-defined object attached to the control.
(Inherited from Control)
TemplateGets or sets the template that defines the control's appearance.
(Inherited from TemplatedControl)
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)
TransparencyBackgroundFallbackGets or sets the IBrush that transparency will blend with when transparency is not supported. By default this is a solid white brush.
TransparencyLevelHintGets or sets the WindowTransparencyLevel that the TopLevel should use when possible. Accepts multiple values which are applied in a fallback order. For instance, with "Mica, Blur" Mica will be applied only on platforms where it is possible, and Blur will be used on the rest of them. Default value is an empty array or "None".
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)
VerticalContentAlignmentGets or sets the vertical alignment of the content within the control.
(Inherited from ContentControl)
VisualChildrenGets the control's child visuals.
(Inherited from Visual)
VisualRootGets the root of the visual tree, if the control is attached to a visual tree.
(Inherited from Visual)
WidthGets or sets the width of the element.
(Inherited from Layoutable)
ZIndexGets 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)
AddHandler(TEventArgs)(RoutedEvent(TEventArgs), EventHandler(TEventArgs), 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 TemplatedControl)
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, IObservable(Object), BindingPriority)Binds a AvaloniaProperty to an observable.
(Inherited from AvaloniaObject)
Bind(T)(DirectPropertyBase(T), IObservable(T))Binds a AvaloniaProperty to an observable.
(Inherited from AvaloniaObject)
Bind(T)(DirectPropertyBase(T), IObservable(BindingValue(T)))Binds a AvaloniaProperty to an observable.
(Inherited from AvaloniaObject)
Bind(T)(DirectPropertyBase(T), IObservable(Object))Binds a AvaloniaProperty to an observable.
(Inherited from AvaloniaObject)
Bind(T)(StyledProperty(T), IObservable(T), BindingPriority)Binds a AvaloniaProperty to an observable.
(Inherited from AvaloniaObject)
Bind(T)(StyledProperty(T), IObservable(BindingValue(T)), BindingPriority)Binds a AvaloniaProperty to an observable.
(Inherited from AvaloniaObject)
Bind(T)(StyledProperty(T), IObservable(Object), 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)
ClearValue(T)(AvaloniaProperty(T))Clears a AvaloniaProperty's local value.
(Inherited from AvaloniaObject)
ClearValue(T)(DirectPropertyBase(T))Clears a AvaloniaProperty's local value.
(Inherited from AvaloniaObject)
ClearValue(T)(StyledProperty(T))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.
(Inherited from InputElement)
GetAutoSafeAreaPadding(Control)Gets if auto safe area padding is enabled.
GetBaseValue(T)(StyledProperty(T))Gets an AvaloniaProperty base value.
(Inherited from AvaloniaObject)
GetHashCode()Gets the hash code for the object.
(Inherited from AvaloniaObject)
GetSystemBarColor(Control)Helper for getting the color of the platform's system bars.
GetTemplateFocusTarget()Gets the element that receives the focus adorner.
(Inherited from TemplatedControl)
GetTopLevel(Visual)Gets the TopLevel for which the given Visual is hosted in.
GetType()Gets the Type of the current instance.
(Inherited from Object)
GetValue(AvaloniaProperty)Gets a AvaloniaProperty value.
(Inherited from AvaloniaObject)
GetValue(T)(DirectPropertyBase(T))Gets a AvaloniaProperty value.
(Inherited from AvaloniaObject)
GetValue(T)(StyledProperty(T))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()
(Overrides Visual.InvalidateMirrorTransform())
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)
OnApplyTemplate(TemplateAppliedEventArgs)
(Overrides TemplatedControl.OnApplyTemplate(TemplateAppliedEventArgs))
OnAttachedToLogicalTree(LogicalTreeAttachmentEventArgs)Called when the styled element is added to a rooted logical tree.
(Inherited from TemplatedControl)
OnAttachedToVisualTree(VisualTreeAttachmentEventArgs)Called when the control is added to a rooted visual tree.
(Overrides Visual.OnAttachedToVisualTree(VisualTreeAttachmentEventArgs))
OnAttachedToVisualTreeCore(VisualTreeAttachmentEventArgs)Calls the OnAttachedToVisualTree(VisualTreeAttachmentEventArgs) method for this control and all of its visual descendants.
(Inherited from Control)
OnClosed(EventArgs)Raises the Closed event.
OnCreateAutomationPeer()Returns a new, type-specific AutomationPeer implementation for the control.
(Inherited from Control)
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 TemplatedControl)
OnDetachedFromVisualTree(VisualTreeAttachmentEventArgs)Called when the control is removed from a rooted visual tree.
(Inherited from Visual)
OnDetachedFromVisualTreeCore(VisualTreeAttachmentEventArgs)
(Inherited from Control)
OnGotFocus(GotFocusEventArgs)Called before the GotFocus event occurs.
(Inherited from Control)
OnInitialized()Called when the control finishes initialization.
(Inherited from StyledElement)
OnKeyDown(KeyEventArgs)Called before the KeyDown event occurs.
(Inherited from InputElement)
OnKeyUp(KeyEventArgs)Called before the KeyUp event occurs.
(Inherited from Control)
OnLoaded(RoutedEventArgs)Invoked just before the Loaded event.
(Inherited from Control)
OnLostFocus(RoutedEventArgs)Called before the LostFocus event occurs.
(Inherited from Control)
OnMeasureInvalidated()Called by InvalidateMeasure
(Inherited from Layoutable)
OnOpened(EventArgs)Raises the Opened event.
OnPointerCaptureLost(PointerCaptureLostEventArgs)Called before the PointerCaptureLost event occurs.
(Inherited from InputElement)
OnPointerEntered(PointerEventArgs)Called before the PointerEntered event occurs.
(Inherited from InputElement)
OnPointerExited(PointerEventArgs)Called before the PointerExited event occurs.
(Inherited from InputElement)
OnPointerMoved(PointerEventArgs)Called before the PointerMoved event occurs.
(Inherited from InputElement)
OnPointerPressed(PointerPressedEventArgs)Called before the PointerPressed event occurs.
(Inherited from InputElement)
OnPointerReleased(PointerReleasedEventArgs)Called before the PointerReleased event occurs.
(Inherited from Control)
OnPointerWheelChanged(PointerWheelEventArgs)Called before the PointerWheelChanged event occurs.
(Inherited from InputElement)
OnPropertyChanged(AvaloniaPropertyChangedEventArgs)
(Overrides ContentControl.OnPropertyChanged(AvaloniaPropertyChangedEventArgs))
OnPropertyChangedCore(AvaloniaPropertyChangedEventArgs)
(Inherited from Animatable)
OnSizeChanged(SizeChangedEventArgs)Invoked just before the SizeChanged event.
(Inherited from Control)
OnTemplateChanged(AvaloniaPropertyChangedEventArgs)Called when the Template property changes.
(Inherited from TemplatedControl)
OnTextInput(TextInputEventArgs)Called before the TextInput event occurs.
(Inherited from InputElement)
OnUnloaded(RoutedEventArgs)Invoked just before the Unloaded event.
(Inherited from Control)
OnVisualParentChanged(Visual, Visual)Called when the control's visual parent changes.
(Inherited from Layoutable)
RaiseEvent(RoutedEventArgs)Raises a routed event.
(Inherited from Interactive)
RaisePropertyChanged(T)(DirectPropertyBase(T), T, T)Raises the PropertyChanged event for a direct property.
(Inherited from AvaloniaObject)
RegisterContentPresenter(ContentPresenter)Called when an ContentPresenter is registered with the control.
(Inherited from ContentControl)
RemoveHandler(RoutedEvent, Delegate)Removes a handler for the specified routed event.
(Inherited from Interactive)
RemoveHandler(TEventArgs)(RoutedEvent(TEventArgs), EventHandler(TEventArgs))Removes a handler for the specified routed event.
(Inherited from Interactive)
Render(DrawingContext)Renders the visual to a DrawingContext.
(Inherited from Visual)
RequestAnimationFrame(Action(TimeSpan))Enqueues a callback to be called on the next animation tick
RequestPlatformInhibition(PlatformInhibitionType, String)Requests a PlatformInhibitionType to be inhibited. The behavior remains inhibited until the return value is disposed. The available set of PlatformInhibitionTypes depends on the platform. If a behavior is inhibited on a platform where this type is not supported the request will have no effect.
SetAndRaise(T)(DirectPropertyBase(T), T, T)Sets the backing field for a direct avalonia property, raising the PropertyChanged event if the value has changed.
(Inherited from AvaloniaObject)
SetAutoSafeAreaPadding(Control, Boolean)Enabled or disables whenever TopLevel should automatically adjust paddings depending on the safe area.
SetCurrentValue(AvaloniaProperty, Object)Sets the value of a dependency property without changing its value source.
(Inherited from AvaloniaObject)
SetCurrentValue(T)(StyledProperty(T), T)Sets the value of a dependency property without changing its value source.
(Inherited from AvaloniaObject)
SetSystemBarColor(Control, SolidColorBrush)Helper for setting the color of the platform's system bars.
SetValue(AvaloniaProperty, Object, BindingPriority)Sets a AvaloniaProperty value.
(Inherited from AvaloniaObject)
SetValue(T)(DirectPropertyBase(T), T)Sets a AvaloniaProperty value.
(Inherited from AvaloniaObject)
SetValue(T)(StyledProperty(T), T, BindingPriority)Sets a AvaloniaProperty value.
(Inherited from AvaloniaObject)
StartRendering() 
StopRendering() 
ToString()Returns a string that represents the current object.
(Inherited from Object)
TryGetPlatformHandle()Trys to get the platform handle for the TopLevel-derived control.
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.
(Inherited from InputElement)
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

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)
BackRequestedOccurs when physical Back Button is pressed or a back navigation has been requested.
ClosedFired when the window is closed.
ContextRequestedOccurs when the user has completed a context input gesture, such as a right-click.
(Inherited from Control)
DataContextChangedOccurs when the 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 a double-tap gesture occurs on the control.
(Inherited from InputElement)
EffectiveViewportChangedOccurs when the element's effective viewport changes.
(Inherited from Layoutable)
GotFocusOccurs when the control receives focus.
(Inherited from InputElement)
HoldingOccurs when a hold gesture occurs on the control.
(Inherited from InputElement)
InitializedOccurs when the styled element has finished initialization.
(Inherited from StyledElement)
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)
LayoutUpdatedOccurs when a layout pass completes for the control.
(Inherited from Layoutable)
LoadedOccurs when the control has been fully constructed in the visual tree and both layout and render are complete.
(Inherited from Control)
LostFocusOccurs when the control loses focus.
(Inherited from InputElement)
OpenedFired when the window is opened.
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)
PointerWheelChangedOccurs when the mouse is scrolled over the control.
(Inherited from InputElement)
PropertyChangedRaised when a AvaloniaProperty value changes on this object.
(Inherited from AvaloniaObject)
ResourcesChangedOccurs when a resource in this styled element or a parent styled element has changed.
(Inherited from StyledElement)
ScalingChangedGets or sets a method called when the TopLevel's scaling changes.
SizeChangedOccurs when the bounds (actual size) of the control have changed.
(Inherited from Control)
TappedOccurs when a tap gesture occurs on the control.
(Inherited from InputElement)
TemplateAppliedRaised when the control's template is applied.
(Inherited from TemplatedControl)
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)
UnloadedOccurs when the control is removed from the visual tree.
(Inherited from Control)

Fields

ActualThemeVariantPropertyDefines the ActualThemeVariant property.
ActualTransparencyLevelPropertyDefines the ActualTransparencyLevel property.
AutoSafeAreaPaddingPropertyDefines the AutoSafeAreaPadding attached property.
BackRequestedEventDefines the BackRequested event.
ClientSizePropertyDefines the ClientSize property.
FrameSizePropertyDefines the FrameSize property.
PointerOverElementPropertyDefines the PointerOverElement property.
RequestedThemeVariantPropertyDefines the RequestedThemeVariant property.
SystemBarColorPropertyDefines the SystemBarColor attached property.
TransparencyBackgroundFallbackPropertyDefines the TransparencyBackgroundFallback property.
TransparencyLevelHintPropertyDefines the TransparencyLevelHint property.

Extension Methods

AddDisposableHandler(TEventArgs)(RoutedEvent(TEventArgs), EventHandler(TEventArgs), RoutingStrategies, Boolean)Adds a handler for the specified routed event and returns a disposable that can terminate the event subscription.
(Defined by InteractiveExtensions)
AttachDevTools()Attaches DevTools to a window, to be opened with the F12 key.
(Defined by DevToolsExtensions)
AttachDevTools(DevToolsOptions)Attaches DevTools to a window, to be opened with the specified options.
(Defined by DevToolsExtensions)
AttachDevTools(KeyGesture)Attaches DevTools to a window, to be opened with the specified key gesture.
(Defined by DevToolsExtensions)
Bind(AvaloniaProperty, IBinding, Object)Binds a property on an AvaloniaObject to an IBinding.
(Defined by AvaloniaObjectExtensions)
Bind(T)(AvaloniaProperty(T), IObservable(BindingValue(T)), BindingPriority)Binds an AvaloniaProperty to an observable.
(Defined by AvaloniaObjectExtensions)
Bind(T)(AvaloniaProperty(T), IObservable(T), BindingPriority)Binds an AvaloniaProperty to an observable.
(Defined by AvaloniaObjectExtensions)
BindClass(String, IBinding, Object)
(Defined by StyledElementExtensions)
BringIntoView()Tries to bring the control into view.
(Defined by ControlExtensions)
BringIntoView(Rect)Tries to bring the control into view.
(Defined by ControlExtensions)
CalculateDistanceFromAncestor(Visual)Calculates the distance from a visual's ancestor.
(Defined by VisualExtensions)
Find(T)(String)Finds a named element in an INameScope.
(Defined by NameScopeExtensions)
FindAncestorOfType(T)(Boolean)Finds first ancestor of given type.
(Defined by VisualExtensions)
FindCommonVisualAncestor(Visual)Tries to get the first common ancestor of two visuals.
(Defined by VisualExtensions)
FindControl(T)(String)Finds the named control in the scope of the specified control.
(Defined by ControlExtensions)
FindDataTemplate(Object, IDataTemplate)Find a data template that matches a piece of data.
(Defined by DataTemplateExtensions)
FindDescendantOfType(T)(Boolean)Finds first descendant of given type.
(Defined by VisualExtensions)
FindLogicalAncestorOfType(T)(Boolean)Finds first ancestor of given type.
(Defined by LogicalExtensions)
FindLogicalDescendantOfType(T)(Boolean)Finds first descendant of given type.
(Defined by LogicalExtensions)
FindNameScope()
(Defined by NameScopeExtensions)
Get(T)(String)Gets a named element from an INameScope or throws if no element of the requested name was found.
(Defined by NameScopeExtensions)
GetBaseValue(AvaloniaProperty)Gets an AvaloniaProperty base value.
(Defined by AvaloniaObjectExtensions)
GetBaseValue(T)(AvaloniaProperty(T))Gets an AvaloniaProperty base value.
(Defined by AvaloniaObjectExtensions)
GetBindingObservable(AvaloniaProperty)Gets an observable for an AvaloniaProperty.
(Defined by AvaloniaObjectExtensions)
GetBindingObservable(T)(AvaloniaProperty(T))Gets an observable for an AvaloniaProperty.
(Defined by AvaloniaObjectExtensions)
GetBindingObservable(TResult)(AvaloniaProperty, Func(Object, TResult))Gets an observable for an AvaloniaProperty.
(Defined by AvaloniaObjectExtensions)
GetBindingObservable(TSource, TResult)(AvaloniaProperty(TSource), Func(TSource, TResult))Gets an observable for an AvaloniaProperty.
(Defined by AvaloniaObjectExtensions)
GetBindingSubject(AvaloniaProperty, BindingPriority)Gets a subject for a AvaloniaProperty.
(Defined by AvaloniaObjectReactiveExtensions)
GetBindingSubject(T)(AvaloniaProperty(T), BindingPriority)Gets a subject for a AvaloniaProperty.
(Defined by AvaloniaObjectReactiveExtensions)
GetControl(T)(String)Finds the named control in the scope of the specified control and throws if not found.
(Defined by ControlExtensions)
GetDiagnostic(AvaloniaProperty)Gets a diagnostic for a AvaloniaProperty on a AvaloniaObject.
(Defined by AvaloniaObjectExtensions)
GetInputElementsAt(Point)Returns the active input elements at a point on an IInputElement.
(Defined by InputExtensions)
GetInputElementsAt(Point, Boolean)Returns the active input elements at a point on an IInputElement.
(Defined by InputExtensions)
GetInteractiveParent()
(Defined by InteractiveExtensions)
GetLogicalAncestors()Enumerates the ancestors of an ILogical in the logical tree.
(Defined by LogicalExtensions)
GetLogicalChildren()Enumerates the children of an ILogical in the logical tree.
(Defined by LogicalExtensions)
GetLogicalDescendants()Enumerates the descendants of an ILogical in the logical tree.
(Defined by LogicalExtensions)
GetLogicalParent()Gets the logical parent of an ILogical.
(Defined by LogicalExtensions)
GetLogicalParent(T)()Gets the logical parent of an ILogical.
(Defined by LogicalExtensions)
GetLogicalSiblings()Enumerates the siblings of an ILogical in the logical tree.
(Defined by LogicalExtensions)
GetObservable(AvaloniaProperty)Gets an observable for an AvaloniaProperty.
(Defined by AvaloniaObjectExtensions)
GetObservable(T)(AvaloniaProperty(T))Gets an observable for an AvaloniaProperty.
(Defined by AvaloniaObjectExtensions)
GetObservable(TResult)(AvaloniaProperty, Func(Object, TResult))Gets an observable for an AvaloniaProperty.
(Defined by AvaloniaObjectExtensions)
GetObservable(TEventArgs)(RoutedEvent(TEventArgs), RoutingStrategies, Boolean)Gets an observable for a RoutedEvent(TEventArgs).
(Defined by InteractiveExtensions)
GetObservable(TSource, TResult)(AvaloniaProperty(TSource), Func(TSource, TResult))Gets an observable for an AvaloniaProperty.
(Defined by AvaloniaObjectExtensions)
GetPropertyChangedObservable(AvaloniaProperty)Gets an observable that listens for property changed events for an AvaloniaProperty.
(Defined by AvaloniaObjectExtensions)
GetSelfAndLogicalAncestors()Enumerates an ILogical and its ancestors in the logical tree.
(Defined by LogicalExtensions)
GetSelfAndLogicalDescendants()Enumerates an ILogical and its descendants in the logical tree.
(Defined by LogicalExtensions)
GetSelfAndVisualAncestors()Enumerates an Visual and its ancestors in the visual tree.
(Defined by VisualExtensions)
GetSelfAndVisualDescendants()Enumerates an Visual and its descendants in the visual tree.
(Defined by VisualExtensions)
GetSubject(AvaloniaProperty, BindingPriority)Gets a subject for an AvaloniaProperty.
(Defined by AvaloniaObjectReactiveExtensions)
GetSubject(T)(AvaloniaProperty(T), BindingPriority)Gets a subject for an AvaloniaProperty.
(Defined by AvaloniaObjectReactiveExtensions)
GetTemplateChildren()
(Defined by TemplateExtensions)
GetTransformedBounds()
(Defined by VisualExtensions)
GetValue(T)(AvaloniaProperty(T))Gets a AvaloniaProperty value.
(Defined by AvaloniaObjectExtensions)
GetValueStoreDiagnostic()Gets a value store diagnostics for a AvaloniaObject.
(Defined by AvaloniaObjectExtensions)
GetVisualAncestors()Enumerates the ancestors of an Visual in the visual tree.
(Defined by VisualExtensions)
GetVisualAt(Point)Gets the first visual in the visual tree whose bounds contain a point.
(Defined by VisualExtensions)
GetVisualAt(Point, Func(Visual, Boolean))Gets the first visual in the visual tree whose bounds contain a point.
(Defined by VisualExtensions)
GetVisualChildren()Enumerates the children of an Visual in the visual tree.
(Defined by VisualExtensions)
GetVisualDescendants()Enumerates the descendants of an Visual in the visual tree.
(Defined by VisualExtensions)
GetVisualParent()Gets the visual parent of an Visual.
(Defined by VisualExtensions)
GetVisualParent(T)()Gets the visual parent of an Visual.
(Defined by VisualExtensions)
GetVisualRoot()Gets the root visual for an Visual.
(Defined by VisualExtensions)
GetVisualsAt(Point)Enumerates the visible visuals in the visual tree whose bounds contain a point.
(Defined by VisualExtensions)
GetVisualsAt(Point, Func(Visual, Boolean))Enumerates the visuals in the visual tree whose bounds contain a point.
(Defined by VisualExtensions)
InputHitTest(Point)Returns the topmost active input element at a point on an IInputElement.
(Defined by InputExtensions)
InputHitTest(Point, Boolean)Returns the topmost active input element at a point on an IInputElement.
(Defined by InputExtensions)
InputHitTest(Point, Func(Visual, Boolean))Returns the topmost active input element at a point on an IInputElement.
(Defined by InputExtensions)
InputHitTest(Point, Func(Visual, Boolean), Boolean)Returns the topmost active input element at a point on an IInputElement.
(Defined by InputExtensions)
IsAttachedToVisualTree()Returns a value indicating whether this control is attached to a visual root.
(Defined by VisualExtensions)
IsLogicalAncestorOf(ILogical)Tests whether an ILogical is an ancestor of another logical.
(Defined by LogicalExtensions)
IsVisualAncestorOf(Visual)Tests whether an Visual is an ancestor of another visual.
(Defined by VisualExtensions)
PointToClient(PixelPoint)Converts a point from screen to client coordinates.
(Defined by VisualExtensions)
PointToScreen(Point)Converts a point from client to screen coordinates.
(Defined by VisualExtensions)
TransformToVisual(Visual)Returns a transform that transforms the visual's coordinates into the coordinates of the specified to.
(Defined by VisualExtensions)
TranslatePoint(Point, Visual)Translates a point relative to this visual to coordinates that are relative to the specified visual.
(Defined by VisualExtensions)

See Also

Reference

Avalonia.Controls Namespace