TopLevel Class

Summary

Base class for top-level widgets.
graph TD Base0["ContentControl"]-->Type click Base0 "/api/Avalonia.Controls/ContentControl" Base1["TemplatedControl"]-->Base0 click Base1 "/api/Avalonia.Controls.Primitives/TemplatedControl" Base2["Control"]-->Base1 click Base2 "/api/Avalonia.Controls/Control" Base3["InputElement"]-->Base2 click Base3 "/api/Avalonia.Input/InputElement" Base4["Interactive"]-->Base3 click Base4 "/api/Avalonia.Interactivity/Interactive" Base5["Layoutable"]-->Base4 click Base5 "/api/Avalonia.Layout/Layoutable" Base6["Visual"]-->Base5 click Base6 "/api/Avalonia/Visual" Base7["Animatable"]-->Base6 click Base7 "/api/Avalonia.Animation/Animatable" Base8["AvaloniaObject"]-->Base7 click Base8 "/api/Avalonia/AvaloniaObject" Base9["object"]-->Base8 Interface0["IAvaloniaObjectDebug"]-.->Type click Interface0 "/api/Avalonia.Diagnostics/IAvaloniaObjectDebug" Interface1["INotifyPropertyChanged"]-.->Type Interface2["IPriorityValueOwner"]-.->Type Interface3["ISetInheritanceParent"]-.->Type click Interface3 "/api/Avalonia.Controls/ISetInheritanceParent" Interface4["ISetLogicalParent"]-.->Type click Interface4 "/api/Avalonia.Controls/ISetLogicalParent" Interface5["ISupportInitialize"]-.->Type click Interface5 "/api/Avalonia/ISupportInitialize" Interface6["IVisualBrushInitialize"]-.->Type click Interface6 "/api/Avalonia.Rendering/IVisualBrushInitialize" Interface7["IContentControl"]-.->Type click Interface7 "/api/Avalonia.Controls/IContentControl" Interface8["IControl"]-.->Type click Interface8 "/api/Avalonia.Controls/IControl" Interface9["IDataTemplateHost"]-.->Type click Interface9 "/api/Avalonia.Controls.Templates/IDataTemplateHost" Interface10["ILogical"]-.->Type click Interface10 "/api/Avalonia.LogicalTree/ILogical" Interface11["IResourceNode"]-.->Type click Interface11 "/api/Avalonia.Controls/IResourceNode" Interface12["IResourceProvider"]-.->Type click Interface12 "/api/Avalonia.Controls/IResourceProvider" Interface13["IStyleable"]-.->Type click Interface13 "/api/Avalonia.Styling/IStyleable" Interface14["INamed"]-.->Type click Interface14 "/api/Avalonia/INamed" Interface15["IContentPresenterHost"]-.->Type click Interface15 "/api/Avalonia.Controls.Presenters/IContentPresenterHost" Interface16["ITemplatedControl"]-.->Type click Interface16 "/api/Avalonia.Styling/ITemplatedControl" Interface17["IAvaloniaObject"]-.->Type click Interface17 "/api/Avalonia/IAvaloniaObject" Interface18["IInputRoot"]-.->Type click Interface18 "/api/Avalonia.Input/IInputRoot" Interface19["IInputElement"]-.->Type click Interface19 "/api/Avalonia.Input/IInputElement" Interface20["IInteractive"]-.->Type click Interface20 "/api/Avalonia.Interactivity/IInteractive" Interface21["ILayoutRoot"]-.->Type click Interface21 "/api/Avalonia.Layout/ILayoutRoot" Interface22["ILayoutable"]-.->Type click Interface22 "/api/Avalonia.Layout/ILayoutable" Interface23["IRenderRoot"]-.->Type click Interface23 "/api/Avalonia.Rendering/IRenderRoot" Interface24["IVisual"]-.->Type click Interface24 "/api/Avalonia.VisualTree/IVisual" Interface25["ICloseable"]-.->Type click Interface25 "/api/Avalonia.Input/ICloseable" Interface26["IStyleRoot"]-.->Type click Interface26 "/api/Avalonia.Styling/IStyleRoot" Interface27["IStyleHost"]-.->Type click Interface27 "/api/Avalonia.Styling/IStyleHost" Interface28["IWeakSubscriber<T>"]-.->Type click Interface28 "/api/Avalonia.Utilities/IWeakSubscriber_1" Type["TopLevel"] class Type type-node Type-->Derived0["WindowBase"] click Derived0 "/api/Avalonia.Controls/WindowBase" Type-->Derived1["EmbeddableControlRoot"] click Derived1 "/api/Avalonia.Controls.Embedding/EmbeddableControlRoot"

Syntax

public abstract class TopLevel : ContentControl, IAvaloniaObjectDebug, INotifyPropertyChanged, 
    IPriorityValueOwner, ISetInheritanceParent, ISetLogicalParent, ISupportInitialize, 
    IVisualBrushInitialize, IContentControl, IControl, IDataTemplateHost, ILogical, IResourceNode, 
    IResourceProvider, IStyleable, INamed, IContentPresenterHost, ITemplatedControl, 
    IAvaloniaObject, IInputRoot, IInputElement, IInteractive, ILayoutRoot, ILayoutable, 
    IRenderRoot, IVisual, ICloseable, IStyleRoot, IStyleHost, 
    IWeakSubscriber<ResourcesChangedEventArgs>

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.

Constructors

Name Summary
TopLevel(ITopLevelImpl) Initializes a new instance of the TopLevel class.
TopLevel(ITopLevelImpl, IAvaloniaDependencyResolver) Initializes a new instance of the TopLevel class.

Events

Name Type Summary
AttachedToLogicalTree EventHandler<TEventArgs>
Raised when the control is attached to a rooted logical tree.
Inherited from Control
AttachedToVisualTree EventHandler<TEventArgs>
Raised when the control is attached to a rooted visual tree.
Inherited from Visual
Closed EventHandler
Fired when the window is closed.
DataContextChanged EventHandler
Occurs when the DataContext property changes.
Inherited from Control
DetachedFromLogicalTree EventHandler<TEventArgs>
Raised when the control is detached from a rooted logical tree.
Inherited from Control
DetachedFromVisualTree EventHandler<TEventArgs>
Raised when the control is detached from a rooted visual tree.
Inherited from Visual
DoubleTapped EventHandler<TEventArgs>
Occurs when a double-tap gesture occurs on the control.
Inherited from InputElement
GotFocus EventHandler<TEventArgs>
Occurs when the control receives focus.
Inherited from InputElement
Initialized EventHandler
Occurs when the control has finished initialization.
Inherited from Control
KeyDown EventHandler<TEventArgs>
Occurs when a key is pressed while the control has focus.
Inherited from InputElement
KeyUp EventHandler<TEventArgs>
Occurs when a key is released while the control has focus.
Inherited from InputElement
LayoutUpdated EventHandler
Occurs when a layout pass completes for the control.
Inherited from Layoutable
LostFocus EventHandler<TEventArgs>
Occurs when the control loses focus.
Inherited from InputElement
PointerEnter EventHandler<TEventArgs>
Occurs when the pointer enters the control.
Inherited from InputElement
PointerLeave EventHandler<TEventArgs>
Occurs when the pointer leaves the control.
Inherited from InputElement
PointerMoved EventHandler<TEventArgs>
Occurs when the pointer moves over the control.
Inherited from InputElement
PointerPressed EventHandler<TEventArgs>
Occurs when the pointer is pressed over the control.
Inherited from InputElement
PointerReleased EventHandler<TEventArgs>
Occurs when the pointer is released over the control.
Inherited from InputElement
PointerWheelChanged EventHandler<TEventArgs>
Occurs when the mouse wheen is scrolled over the control.
Inherited from InputElement
PropertyChanged EventHandler<TEventArgs>
Raised when a AvaloniaProperty value changes on this object.
Inherited from AvaloniaObject
ResourcesChanged EventHandler<TEventArgs>
Occurs when a resource in this control or a parent control has changed.
Inherited from Control
Tapped EventHandler<TEventArgs>
Occurs when a tap gesture occurs on the control.
Inherited from InputElement
TemplateApplied EventHandler<TEventArgs>
Raised when the control's template is applied.
Inherited from TemplatedControl
TextInput EventHandler<TEventArgs>
Occurs when a user typed some text while the control has focus.
Inherited from InputElement

Fields

Name Constant Value Summary
BackgroundProperty
Defines the Background property.
Inherited from TemplatedControl
static
BorderBrushProperty
Defines the BorderBrush property.
Inherited from TemplatedControl
static
BorderThicknessProperty
Defines the BorderThickness property.
Inherited from TemplatedControl
static
BoundsProperty
Defines the Bounds property.
Inherited from Visual
static
ClientSizeProperty
Defines the ClientSize property.
static
ClipProperty
Defines the Clip property.
Inherited from Visual
static
ClipToBoundsProperty
Defines the ClipToBounds property.
Inherited from Visual
static
ContentProperty
Defines the Content property.
Inherited from ContentControl
static
ContentTemplateProperty
Defines the ContentTemplate property.
Inherited from ContentControl
static
ContextMenuProperty
Defines the ContextMenu property.
Inherited from Control
static
CursorProperty
Gets or sets associated mouse cursor.
Inherited from InputElement
static
DataContextProperty
Defines the DataContext property.
Inherited from Control
static
DesiredSizeProperty
Defines the DesiredSize property.
Inherited from Layoutable
static
DoubleTappedEvent
Defines the DoubleTapped event.
Inherited from InputElement
static
FocusableProperty
Defines the Focusable property.
Inherited from InputElement
static
FocusAdornerProperty
Defines the FocusAdorner property.
Inherited from Control
static
FontFamilyProperty
Defines the FontFamily property.
Inherited from TemplatedControl
static
FontSizeProperty
Defines the FontSize property.
Inherited from TemplatedControl
static
FontStyleProperty
Defines the FontStyle property.
Inherited from TemplatedControl
static
FontWeightProperty
Defines the FontWeight property.
Inherited from TemplatedControl
static
ForegroundProperty
Defines the Foreground property.
Inherited from TemplatedControl
static
GotFocusEvent
Defines the GotFocus event.
Inherited from InputElement
static
HeightProperty
Defines the Height property.
Inherited from Layoutable
static
HorizontalAlignmentProperty
Defines the HorizontalAlignment property.
Inherited from Layoutable
static
HorizontalContentAlignmentProperty
Defines the HorizontalContentAlignment property.
Inherited from ContentControl
static
IsEnabledCoreProperty
Defines the IsEnabledCore property.
Inherited from InputElement
static
IsEnabledProperty
Defines the IsEnabled property.
Inherited from InputElement
static
IsFocusedProperty
Defines the IsFocused property.
Inherited from InputElement
static
IsHitTestVisibleProperty
Defines the IsHitTestVisible property.
Inherited from InputElement
static
IsPointerOverProperty
Defines the IsPointerOver property.
Inherited from InputElement
static
IsTemplateFocusTargetProperty
Defines the IsTemplateFocusTarget attached property.
Inherited from TemplatedControl
static
IsVisibleProperty
Defines the IsVisibleProperty property.
Inherited from Visual
static
KeyDownEvent
Defines the KeyDown event.
Inherited from InputElement
static
KeyUpEvent
Defines the KeyUp event.
Inherited from InputElement
static
LostFocusEvent
Defines the LostFocus event.
Inherited from InputElement
static
MarginProperty
Defines the Margin property.
Inherited from Layoutable
static
MaxHeightProperty
Defines the MaxHeight property.
Inherited from Layoutable
static
MaxWidthProperty
Defines the MaxWidth property.
Inherited from Layoutable
static
MinHeightProperty
Defines the MinHeight property.
Inherited from Layoutable
static
MinWidthProperty
Defines the MinWidth property.
Inherited from Layoutable
static
NameProperty
Defines the Name property.
Inherited from Control
static
OpacityMaskProperty
Defines the OpacityMask property.
Inherited from Visual
static
OpacityProperty
Defines the Opacity property.
Inherited from Visual
static
PaddingProperty
Defines the Padding property.
Inherited from TemplatedControl
static
ParentProperty
Defines the Parent property.
Inherited from Control
static
PointerEnterEvent
Defines the PointerEnter event.
Inherited from InputElement
static
PointerLeaveEvent
Defines the PointerLeave event.
Inherited from InputElement
static
PointerMovedEvent
Defines the PointerMoved event.
Inherited from InputElement
static
PointerOverElementProperty
Defines the PointerOverElement property.
static
PointerPressedEvent
Defines the PointerPressed event.
Inherited from InputElement
static
PointerReleasedEvent
Defines the PointerReleased event.
Inherited from InputElement
static
PointerWheelChangedEvent
Defines the PointerWheelChanged event.
Inherited from InputElement
static
RenderTransformOriginProperty
Defines the RenderTransformOrigin property.
Inherited from Visual
static
RenderTransformProperty
Defines the RenderTransform property.
Inherited from Visual
static
RequestBringIntoViewEvent
Event raised when an element wishes to be scrolled into view.
Inherited from Control
static
TagProperty
Defines the Tag property.
Inherited from Control
static
TappedEvent
Defines the Tapped event.
Inherited from InputElement
static
TemplateAppliedEvent
Defines the TemplateApplied routed event.
Inherited from TemplatedControl
static
TemplatedParentProperty
Defines the TemplatedParent property.
Inherited from Control
static
TemplateProperty
Defines the Template property.
Inherited from TemplatedControl
static
TextInputEvent
Defines the TextInput event.
Inherited from InputElement
static
TransformedBoundsProperty
Inherited from Visual
static
UseLayoutRoundingProperty
Defines the UseLayoutRoundingProperty property.
Inherited from Layoutable
static
VerticalAlignmentProperty
Defines the VerticalAlignment property.
Inherited from Layoutable
static
VerticalContentAlignmentProperty
Defines the VerticalContentAlignment property.
Inherited from ContentControl
static
VisualParentProperty
Defines the VisualParent property.
Inherited from Visual
static
WidthProperty
Defines the Width property.
Inherited from Layoutable
static
ZIndexProperty
Defines the ZIndex property.
Inherited from Visual
static

Properties

Name Value Summary
Background IBrush
Gets or sets the brush used to draw the control's background.
Inherited from TemplatedControl
BorderBrush IBrush
Gets or sets the brush used to draw the control's border.
Inherited from TemplatedControl
BorderThickness double
Gets or sets the thickness of the control's border.
Inherited from TemplatedControl
Bounds Rect
Gets the bounds of the control relative to its parent.
Inherited from Visual
Classes Classes
Gets or sets the control's classes.
Inherited from Control
ClientSize Size
Gets or sets the client size of the window.
Clip Geometry
Gets or sets the geometry clip for this visual.
Inherited from Visual
ClipToBounds bool
Gets a value indicating whether the control should be clipped to its bounds.
Inherited from Visual
Content object
Gets or sets the content to display.
Inherited from ContentControl
ContentTemplate IDataTemplate
Gets or sets the data template used to display the content of the control.
Inherited from ContentControl
ContextMenu ContextMenu
Gets or sets a context menu to the control.
Inherited from Control
Cursor Cursor
Gets or sets associated mouse cursor.
Inherited from InputElement
DataContext object
Gets or sets the control's data context.
Inherited from Control
DataTemplates DataTemplates
Gets or sets the data templates for the control.
Inherited from Control
DesiredSize Size
Gets the size that this element computed during the measure pass of the layout process.
Inherited from Layoutable
Focusable bool
Gets or sets a value indicating whether the control can receive focus.
Inherited from InputElement
FocusAdorner ITemplate<TControl>
Gets or sets the control's focus adorner.
Inherited from Control
FontFamily string
Gets or sets the font family used to draw the control's text.
Inherited from TemplatedControl
FontSize double
Gets or sets the size of the control's text in points.
Inherited from TemplatedControl
FontStyle FontStyle
Gets or sets the font style used to draw the control's text.
Inherited from TemplatedControl
FontWeight FontWeight
Gets or sets the font weight used to draw the control's text.
Inherited from TemplatedControl
Foreground IBrush
Gets or sets the brush used to draw the control's text and other foreground elements.
Inherited from TemplatedControl
Height double
Gets or sets the height of the element.
Inherited from Layoutable
HorizontalAlignment HorizontalAlignment
Gets or sets the element's preferred horizontal alignment in its parent.
Inherited from Layoutable
HorizontalContentAlignment HorizontalAlignment
Gets or sets the horizontal alignment of the content within the control.
Inherited from ContentControl
InheritanceParent IAvaloniaObject
Gets or sets the parent object that inherited AvaloniaProperty values are inherited from.
Inherited from AvaloniaObject
IsArrangeValid bool
Gets a value indicating whether the control's layouts arrange is valid.
Inherited from Layoutable
IsEffectivelyVisible bool
Gets a value indicating whether this control and all its parents are visible.
Inherited from Visual
IsEnabled bool
Gets or sets a value indicating whether the control is enabled for user interaction.
Inherited from InputElement
IsEnabledCore bool
Gets a value indicating whether the control is effectively enabled for user interaction.
Inherited from InputElement
IsFocused bool
Gets or sets a value indicating whether the control is focused.
Inherited from InputElement
IsHitTestVisible bool
Gets or sets a value indicating whether the control is considered for hit testing.
Inherited from InputElement
IsInitialized bool
Gets a value that indicates whether the element has finished initialization.
Inherited from Control
IsMeasureValid bool
Gets a value indicating whether the control's layout measure is valid.
Inherited from Layoutable
IsPointerOver bool
Gets or sets a value indicating whether the pointer is currently over the control.
Inherited from InputElement
IsVisible bool
Gets a value indicating whether this control is visible.
Inherited from Visual
KeyBindings List<T>
Inherited from InputElement
LogicalChildren IAvaloniaList<T>
Gets the control's logical children.
Inherited from Control
Margin Thickness
Gets or sets the margin around the element.
Inherited from Layoutable
MaxHeight double
Gets or sets the maximum height of the element.
Inherited from Layoutable
MaxWidth double
Gets or sets the maximum width of the element.
Inherited from Layoutable
MinHeight double
Gets or sets the minimum height of the element.
Inherited from Layoutable
MinWidth double
Gets or sets the minimum width of the element.
Inherited from Layoutable
Name string
Gets or sets the name of the control.
Inherited from Control
Opacity double
Gets the opacity of the control.
Inherited from Visual
OpacityMask IBrush
Gets the opacity mask of the control.
Inherited from Visual
Padding Thickness
Gets or sets the padding placed between the border of the control and its content.
Inherited from TemplatedControl
Parent IControl
Gets the control's logical parent.
Inherited from Control
PlatformImpl ITopLevelImpl
Gets the platform-specific window implementation.
Presenter IContentPresenter
Gets the presenter from the control's template.
Inherited from ContentControl
PropertyTransitions PropertyTransitions
Gets or sets the property transitions for the control.
Inherited from Animatable
PseudoClasses IPseudoClasses
Gets the Classes collection in a form that allows adding and removing pseudoclasses.
Inherited from Control
Renderer IRenderer
Gets the renderer for the window.
RenderTransform Transform
Gets the render transform of the control.
Inherited from Visual
RenderTransformOrigin RelativePoint
Gets the transform origin of the control.
Inherited from Visual
Resources IResourceDictionary
Gets or sets the control's resource dictionary.
Inherited from Control
Styles Styles
Gets the styles for the control.
Inherited from Control
Tag object
Gets or sets a user-defined object attached to the control.
Inherited from Control
Template IControlTemplate
Gets or sets the template that defines the control's appearance.
Inherited from TemplatedControl
TemplatedParent ITemplatedControl
Gets the control whose lookless template this control is part of.
Inherited from Control
this[AvaloniaProperty] object
Gets or sets the value of a AvaloniaProperty.
Inherited from AvaloniaObject
this[IndexerDescriptor] IBinding
Gets or sets a binding for a AvaloniaProperty.
Inherited from AvaloniaObject
TransformedBounds Nullable<T>
Gets the bounds of the control relative to the window, accounting for rendering transforms.
Inherited from Visual
UseLayoutRounding bool
Gets or sets a value that determines whether the element should be snapped to pixel boundaries at layout time.
Inherited from Layoutable
VerticalAlignment VerticalAlignment
Gets or sets the element's preferred vertical alignment in its parent.
Inherited from Layoutable
VerticalContentAlignment VerticalAlignment
Gets or sets the vertical alignment of the content within the control.
Inherited from ContentControl
VisualChildren IAvaloniaList<T>
Gets the control's child visuals.
Inherited from Visual
VisualRoot IRenderRoot
Gets the root of the visual tree, if the control is attached to a visual tree.
Inherited from Visual
Width double
Gets or sets the width of the element.
Inherited from Layoutable
ZIndex int
Gets the Z index of the control.
Inherited from Visual

Methods

Name Value Summary
AddHandler(RoutedEvent, Delegate, RoutingStrategies, bool) IDisposable
Adds a handler for the specified routed event.
Inherited from Interactive
AddHandler<TEventArgs>(RoutedEvent<TEventArgs>, EventHandler<TEventArgs>, RoutingStrategies, bool) IDisposable
Adds a handler for the specified routed event.
Inherited from Interactive
AffectsArrange(AvaloniaProperty[]) void
Marks a property as affecting the control's arrangement.
Inherited from Layoutable
static
AffectsMeasure(AvaloniaProperty[]) void
Marks a property as affecting the control's measurement.
Inherited from Layoutable
static
AffectsRender(AvaloniaProperty[]) void
Indicates that a property change should cause InvalidateVisual() to be called.
Inherited from Visual
static
AffectsValidation(AvaloniaProperty, AvaloniaProperty[]) void
Forces revalidation of properties when a property value changes.
Inherited from AvaloniaObject
static
ApplyTemplate() void
Creates the visual children of the control, if necessary
Inherited from TemplatedControl
Arrange(Rect) void
Arranges the control and its children.
Inherited from Layoutable
ArrangeCore(Rect) void
The default implementation of the control's arrange pass.
Inherited from Layoutable
ArrangeOverride(Size) Size
Positions child elements as part of a layout pass.
Inherited from Layoutable
BeginInit() void
Signals the object that initialization is starting.
Inherited from Control
Bind(AvaloniaProperty, IObservable<object>, BindingPriority) IDisposable
Binds a AvaloniaProperty to an observable.
Inherited from AvaloniaObject
Bind<T>(AvaloniaProperty<T>, IObservable<T>, BindingPriority) IDisposable
Binds a AvaloniaProperty to an observable.
Inherited from AvaloniaObject
CheckAccess() bool
Inherited from AvaloniaObject
ClearValue(AvaloniaProperty) void
Clears a AvaloniaProperty's local value.
Inherited from AvaloniaObject
CreateRenderTarget() IRenderTarget
EndInit() void
Signals the object that initialization is complete.
Inherited from Control
Focus() void
Focuses the control.
Inherited from InputElement
GetIsTemplateFocusTarget(Control) bool
Gets the value of the IsTemplateFocusTargetProperty attached property on a control.
Inherited from TemplatedControl
GetRegistered(AvaloniaProperty) AvaloniaProperty
Given a AvaloniaProperty returns a registered avalonia property that is equal or throws if not found.
Inherited from AvaloniaObject
GetTemplateFocusTarget() IControl
Gets the element that recieves the focus adorner.
Inherited from TemplatedControl
GetValue(AvaloniaProperty) object
Gets a AvaloniaProperty value.
Inherited from AvaloniaObject
GetValue<T>(AvaloniaProperty<T>) T
Gets a AvaloniaProperty value.
Inherited from AvaloniaObject
HandleApplicationExiting() void
Handles the application exiting, either from the last window closing, or a call to Exit().
HandleClosed() void
Handles a closed notification from Closed.
HandlePaint(Rect) void
Handles a paint notification from Resized.
HandleResized(Size) void
Handles a resize notification from Resized.
HandleScalingChanged(double) void
Handles a window scaling change notification from ScalingChanged.
InvalidateArrange() void
Invalidates the arrangement of the control and queues a new layout pass.
Inherited from Layoutable
InvalidateMeasure() void
Invalidates the measurement of the control and queues a new layout pass.
Inherited from Layoutable
InvalidateVisual() void
Invalidates the visual and queues a repaint.
Inherited from Visual
IsAnimating(AvaloniaProperty) bool
Checks whether a AvaloniaProperty is animating.
Inherited from AvaloniaObject
IsSet(AvaloniaProperty) bool
Checks whether a AvaloniaProperty is set on this object.
Inherited from AvaloniaObject
Measure(Size) void
Carries out a measure of the control.
Inherited from Layoutable
MeasureCore(Size) Size
The default implementation of the control's measure pass.
Inherited from Layoutable
MeasureOverride(Size) Size
Measures the control and its child elements as part of a layout pass.
Inherited from Layoutable
OnAttachedToLogicalTree(LogicalTreeAttachmentEventArgs) void
Called when the control is added to a rooted logical tree.
Inherited from TemplatedControl
OnAttachedToVisualTree(VisualTreeAttachmentEventArgs) void
Called when the control is added to a visual tree.
OnAttachedToVisualTreeCore(VisualTreeAttachmentEventArgs) void
Inherited from Control
OnDataContextBeginUpdate() void
Called when the DataContext begins updating.
Inherited from Control
OnDataContextChanged(EventArgs) void
Called when the DataContext property changes.
Inherited from Control
OnDataContextEndUpdate() void
Called when the DataContext finishes updating.
Inherited from Control
OnDetachedFromLogicalTree(LogicalTreeAttachmentEventArgs) void
Called when the control is removed from a rooted logical tree.
Inherited from TemplatedControl
OnDetachedFromVisualTree(VisualTreeAttachmentEventArgs) void
Called when the control is removed from a visual tree.
Inherited from Visual
OnDetachedFromVisualTreeCore(VisualTreeAttachmentEventArgs) void
Inherited from Control
OnGotFocus(GotFocusEventArgs) void
Called before the GotFocus event occurs.
Inherited from Control
OnKeyDown(KeyEventArgs) void
Called before the KeyDown event occurs.
Inherited from InputElement
OnKeyUp(KeyEventArgs) void
Called before the KeyUp event occurs.
Inherited from InputElement
OnLostFocus(RoutedEventArgs) void
Called before the LostFocus event occurs.
Inherited from Control
OnMeasureInvalidated() void
Called by InvalidateMeasure
Inherited from Layoutable
OnPointerEnter(PointerEventArgs) void
Called before the PointerEnter event occurs.
Inherited from InputElement
OnPointerLeave(PointerEventArgs) void
Called before the PointerLeave event occurs.
Inherited from InputElement
OnPointerMoved(PointerEventArgs) void
Called before the PointerMoved event occurs.
Inherited from InputElement
OnPointerPressed(PointerPressedEventArgs) void
Called before the PointerPressed event occurs.
Inherited from InputElement
OnPointerReleased(PointerReleasedEventArgs) void
Called before the PointerReleased event occurs.
Inherited from InputElement
OnPointerWheelChanged(PointerWheelEventArgs) void
Called before the PointerWheelChanged event occurs.
Inherited from InputElement
OnPropertyChanged(AvaloniaPropertyChangedEventArgs) void
Reacts to a change in a AvaloniaProperty value in order to animate the change if a PropertyTransition is set for the property..
Inherited from Animatable
OnTemplateApplied(TemplateAppliedEventArgs) void
Called when the control's template is applied.
Inherited from TemplatedControl
OnTemplateChanged(AvaloniaPropertyChangedEventArgs) void
Called when the Template property changes.
Inherited from TemplatedControl
OnTextInput(TextInputEventArgs) void
Called before the TextInput event occurs.
Inherited from InputElement
OnVisualParentChanged(IVisual, IVisual) void
Called when the control's visual parent changes.
Inherited from Layoutable
PseudoClass(AvaloniaProperty<bool>, string) void
Adds a pseudo-class to be set when a property is true.
Inherited from Control
static
PseudoClass<T>(AvaloniaProperty<T>, Func<T, bool>, string) void
Adds a pseudo-class to be set when a property equals a certain value.
Inherited from Control
static
RaiseEvent(RoutedEventArgs) void
Raises a routed event.
Inherited from Interactive
RaisePropertyChanged(AvaloniaProperty, object, object, BindingPriority) void
Raises the PropertyChanged event.
Inherited from AvaloniaObject
RemoveHandler(RoutedEvent, Delegate) void
Removes a handler for the specified routed event.
Inherited from Interactive
RemoveHandler<TEventArgs>(RoutedEvent<TEventArgs>, EventHandler<TEventArgs>) void
Removes a handler for the specified routed event.
Inherited from Interactive
Render(DrawingContext) void
Renders the visual to a DrawingContext.
Inherited from Visual
Revalidate(AvaloniaProperty) void
Forces the specified property to be revalidated.
Inherited from AvaloniaObject
SetAndRaise<T>(AvaloniaProperty<T>, T, AvaloniaObject.SetAndRaiseCallback<T>, T) bool
Sets the backing field for a direct avalonia property, raising the PropertyChanged event if the value has changed.
Inherited from AvaloniaObject
SetAndRaise<T>(AvaloniaProperty<T>, T, T) bool
Sets the backing field for a direct avalonia property, raising the PropertyChanged event if the value has changed.
Inherited from AvaloniaObject
SetIsTemplateFocusTarget(Control, bool) void
Sets the value of the IsTemplateFocusTargetProperty attached property on a control.
Inherited from TemplatedControl
SetValue(AvaloniaProperty, object, BindingPriority) void
Sets a AvaloniaProperty value.
Inherited from AvaloniaObject
SetValue<T>(AvaloniaProperty<T>, T, BindingPriority) void
Sets a AvaloniaProperty value.
Inherited from AvaloniaObject
TransformToVisual(IVisual) Nullable<T>
Returns a transform that transforms the visual's coordinates into the coordinates of the specified visual.
Inherited from Visual
UpdateDataValidation(AvaloniaProperty, BindingNotification) void
Called to update the validation state for properties for which data validation is enabled.
Inherited from AvaloniaObject
VerifyAccess() void
Inherited from AvaloniaObject

Extension Methods

Name Value Summary
AttachDevTools() void
Bind(AvaloniaProperty, IBinding, object) IDisposable
Binds a property on an IAvaloniaObject to an IBinding.
BringIntoView() void
Tries to being the control into view.
BringIntoView(Rect) void
Tries to being the control into view.
CalculateDistanceFromAncestor(IVisual) int
Calculates the distance from a visual's IRenderRoot.
FindCommonVisualAncestor(IVisual) IVisual
Tries to get the first common ancestor of two visuals.
FindControl<T>(string) T
Finds the named control in the scope of the specified control.
FindDataTemplate(object, IDataTemplate) IDataTemplate
Find a data template that matches a piece of data.
FindNameScope() INameScope
Finds the name scope for a control by searching up the logical tree.
FindResource(string) object
Finds the specified resource by searching up the logical tree and then global styles.
GetDiagnostic(AvaloniaProperty) AvaloniaPropertyValue
Gets a diagnostic for a AvaloniaProperty on a AvaloniaObject.
GetInputElementsAt(Point) IEnumerable<T>
Returns the active input elements at a point on an IInputElement.
GetLogicalAncestors() IEnumerable<T>
GetLogicalChildren() IEnumerable<T>
GetLogicalDescendants() IEnumerable<T>
GetLogicalParent() ILogical
GetLogicalParent<T>() T
GetLogicalSiblings() IEnumerable<T>
GetObservable(AvaloniaProperty) IObservable<T>
Gets an observable for a AvaloniaProperty.
GetObservable<T>(AvaloniaProperty<T>) IObservable<T>
Gets an observable for a AvaloniaProperty.
GetObservable<TEventArgs>(RoutedEvent<TEventArgs>, RoutingStrategies, bool) IObservable<T>
Gets an observable for a RoutedEvent<TEventArgs>.
GetObservableWithHistory<T>(AvaloniaProperty<T>) IObservable<T>
Gets an observable for a AvaloniaProperty.
GetResourceObservable(string) IObservable<T>
GetSelfAndLogicalAncestors() IEnumerable<T>
GetSelfAndLogicalDescendants() IEnumerable<T>
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.
GetSubject(AvaloniaProperty, BindingPriority) ISubject<>
Gets a subject for a AvaloniaProperty.
GetSubject<T>(AvaloniaProperty<T>, BindingPriority) ISubject<>
Gets a subject for a AvaloniaProperty.
GetTemplateChildren() IEnumerable<T>
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.
GetWeakObservable(AvaloniaProperty) IObservable<T>
Gets a weak observable for a AvaloniaProperty.
InputHitTest(Point) IInputElement
Returns the topmost active input element at a point on an IInputElement.
IsLogicalParentOf(ILogical) bool
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
TryFindResource(string, object) bool
Tries to the specified resource by searching up the logical tree and then global styles.