Skip to main content

TopLevel Class

Definition

Assembly:Avalonia.Controls
Package:Avalonia

Base class for top-level widgets.

public class TopLevel

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 Avalonia.Controls.TopLevel.ClientSize.

Constructors

NameDescription
TopLevelInitializes a new instance of the Avalonia.Controls.TopLevel class.

TopLevel Constructor

Initializes a new instance of the Avalonia.Controls.TopLevel class.

public TopLevel(Avalonia.Platform.ITopLevelImpl impl)

Parameters

impl Avalonia.Platform.ITopLevelImpl

The platform-specific window implementation.

Methods

NameDescription
GetAutoSafeAreaPaddingGets if auto safe area padding is enabled.
GetSystemBarColorHelper for getting the color of the platform's system bars.
GetTopLevelGets the Avalonia.Controls.TopLevel for which the given Avalonia.Visual is hosted in.
RequestAnimationFrameNo summary available.
RequestPlatformInhibitionRequests a Avalonia.Controls.PlatformInhibitionType to be inhibited. The behavior remains inhibited until the return value is disposed. The available set of Avalonia.Controls.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.
SetAutoSafeAreaPaddingEnabled or disables whenever TopLevel should automatically adjust paddings depending on the safe area.
SetSystemBarColorGets or sets the keyboard navigation handler for the window.
TryGetPlatformHandleTrys to get the platform handle for the TopLevel-derived control.
ApplyTemplateCreates the visual children of the control, if necessary Inherited from TemplatedControl.
GetIsTemplateFocusTargetGets the value of the IsTemplateFocusTargetProperty attached property on a control. Inherited from TemplatedControl.
SetIsTemplateFocusTargetSets the value of the IsTemplateFocusTargetProperty attached property on a control. Inherited from TemplatedControl.
FocusFocuses the control. Inherited from InputElement.
GetIsHoldWithMouseEnabledInherited from InputElement.
GetIsHoldingEnabledInherited from InputElement.
SetIsHoldWithMouseEnabledInherited from InputElement.
SetIsHoldingEnabledInherited from InputElement.
AddHandler (2 overloads)Adds a handler for the specified routed event. Inherited from Interactive.
RaiseEventRaises a routed event. Inherited from Interactive.
RemoveHandler (2 overloads)Removes a handler for the specified routed event. Inherited from Interactive.
ArrangeArranges the control and its children. Inherited from Layoutable.
InvalidateArrangeInvalidates the arrangement of the control and queues a new layout pass. Inherited from Layoutable.
InvalidateMeasureInvalidates the measurement of the control and queues a new layout pass. Inherited from Layoutable.
MeasureCarries out a measure of the control. Inherited from Layoutable.
UpdateLayoutExecutes a layout pass. Inherited from Layoutable.
GetFlowDirectionGets the value of the attached Avalonia.Visual.FlowDirectionProperty on a control. Inherited from Visual.
InvalidateVisualInvalidates the visual and queues a repaint. Inherited from Visual.
RenderRenders the visual to a Avalonia.Media.DrawingContext. Inherited from Visual.
SetFlowDirectionSets the value of the attached Avalonia.Visual.FlowDirectionProperty on a control. Inherited from Visual.
ApplyStylingApplies styling to the control if the control is initialized and styling is not already applied. Inherited from StyledElement.
BeginInitInherited from StyledElement.
EndInitInherited from StyledElement.
TryGetResourceInherited from StyledElement.
Bind (8 overloads)Binds a Avalonia.AvaloniaProperty to an Avalonia.Data.BindingBase. Inherited from AvaloniaObject.
CheckAccessReturns a value indicating whether the current thread is the UI thread. Inherited from AvaloniaObject.
ClearValue (4 overloads)Clears a Avalonia.AvaloniaProperty's local value. Inherited from AvaloniaObject.
CoerceValueCoerces the specified Avalonia.AvaloniaProperty. Inherited from AvaloniaObject.
EqualsCompares two objects using reference equality. Inherited from AvaloniaObject.
GetBaseValueInherited from AvaloniaObject.
GetHashCodeGets the hash code for the object. Inherited from AvaloniaObject.
GetValue (3 overloads)Gets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject.
IsAnimatingChecks whether a Avalonia.AvaloniaProperty is animating. Inherited from AvaloniaObject.
IsSetChecks whether a Avalonia.AvaloniaProperty is set on this object. Inherited from AvaloniaObject.
SetCurrentValue (2 overloads)Sets the value of a dependency property without changing its value source. Inherited from AvaloniaObject.
SetValue (3 overloads)Sets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject.
VerifyAccessChecks that the current thread is the UI thread and throws if not. Inherited from AvaloniaObject.

GetAutoSafeAreaPadding Method

Gets if auto safe area padding is enabled.

public bool GetAutoSafeAreaPadding(Avalonia.Controls.Control control)

Parameters

control Avalonia.Controls.Control

The main view attached to the toplevel, or the toplevel.

Returns

bool

GetSystemBarColor Method

Helper for getting the color of the platform's system bars.

public Avalonia.Media.SolidColorBrush GetSystemBarColor(Avalonia.Controls.Control control)

Parameters

control Avalonia.Controls.Control

The main view attached to the toplevel, or the toplevel.

Returns

Avalonia.Media.SolidColorBrush

The current color of the platform's system bars.

GetTopLevel Method

Gets the Avalonia.Controls.TopLevel for which the given Avalonia.Visual is hosted in.

public Avalonia.Controls.TopLevel GetTopLevel(Avalonia.Visual visual)

Parameters

visual Avalonia.Visual

The visual to query its TopLevel

Returns

Avalonia.Controls.TopLevel

The TopLevel

RequestAnimationFrame Method

public void RequestAnimationFrame(Action<TimeSpan> action)

Parameters

action Action<TimeSpan>

RequestPlatformInhibition Method

Requests a Avalonia.Controls.PlatformInhibitionType to be inhibited. The behavior remains inhibited until the return value is disposed. The available set of Avalonia.Controls.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.

public System.Threading.Tasks.Task<IDisposable> RequestPlatformInhibition(Avalonia.Controls.PlatformInhibitionType type, string reason)

Parameters

type Avalonia.Controls.PlatformInhibitionType

reason string

Returns

System.Threading.Tasks.Task<IDisposable>

SetAutoSafeAreaPadding Method

Enabled or disables whenever TopLevel should automatically adjust paddings depending on the safe area.

public void SetAutoSafeAreaPadding(Avalonia.Controls.Control control, bool value)

Parameters

control Avalonia.Controls.Control

The main view attached to the toplevel, or the toplevel.

value bool

Value to be set.

SetSystemBarColor Method

Gets or sets the keyboard navigation handler for the window.

public void SetSystemBarColor(Avalonia.Controls.Control control, Avalonia.Media.SolidColorBrush color)

Parameters

control Avalonia.Controls.Control

The main view attached to the toplevel, or the toplevel.

color Avalonia.Media.SolidColorBrush

The color to set.

TryGetPlatformHandle Method

Trys to get the platform handle for the TopLevel-derived control.

public Avalonia.Platform.IPlatformHandle TryGetPlatformHandle()

Returns

Avalonia.Platform.IPlatformHandle

An Avalonia.Platform.IPlatformHandle describing the window handle, or null if the handle could not be retrieved.

Properties

NameDescription
ActualTransparencyLevelGets the achieved Avalonia.Controls.WindowTransparencyLevel that the platform was able to provide.
ClientSizeGets or sets the client size of the window.
ClipboardGets the platform's clipboard implementation
FocusManagerGets focus manager of the root.
FrameSizeGets or sets the total size of the window.
InputPaneNo summary available.
InsetsManagerNo summary available.
LauncherNo summary available.
PlatformImplGets the platform-specific window implementation.
RenderScalingNo summary available.
RendererDiagnosticsGets a value indicating whether the renderer should draw specific diagnostics.
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.
ScreensGets platform screens implementation.
StorageProviderFile System storage service used for file pickers and bookmarks.
TransparencyBackgroundFallbackGets or sets the Avalonia.Media.IBrush that transparency will blend with when transparency is not supported. By default this is a solid white brush.
TransparencyLevelHintGets or sets the Avalonia.Controls.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".
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.
HorizontalContentAlignmentGets or sets the horizontal alignment of the content within the control. Inherited from ContentControl.
PresenterGets the presenter from the control's template. Inherited from ContentControl.
VerticalContentAlignmentGets or sets the vertical alignment of the content within the control. Inherited from ContentControl.
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.
CornerRadiusGets or sets the radius of the border rounded corners. Inherited from TemplatedControl.
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.
LetterSpacingGets or sets the letter spacing for the control's text content. Inherited from TemplatedControl.
PaddingGets or sets the padding placed between the border of the control and its content. Inherited from TemplatedControl.
TemplateGets or sets the template that defines the control's appearance. Inherited from TemplatedControl.
ContextFlyoutGets or sets a context flyout to the control Inherited from Control.
ContextMenuGets or sets a context menu to the control. Inherited from Control.
DataTemplatesGets or sets the data templates for the control. Inherited from Control.
FocusAdornerGets or sets the control's focus adorner. Inherited from Control.
IsLoadedGets a value indicating whether the control is fully constructed in the visual tree and both layout and render are complete. Inherited from Control.
TagGets or sets a user-defined object attached to the control. Inherited from Control.
CursorGets or sets associated mouse cursor. Inherited from InputElement.
FocusableGets or sets a value indicating whether the control can receive focus. Inherited from InputElement.
GestureRecognizersInherited from InputElement.
IsEffectivelyEnabledGets a value indicating whether this control and all its parents are enabled. Inherited from InputElement.
IsEnabledGets or sets a value indicating whether the control is enabled for user interaction. 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.
IsKeyboardFocusWithinGets a value indicating whether keyboard focus is anywhere within the element or its visual tree child elements. Inherited from InputElement.
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.
KeyBindingsInherited from InputElement.
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.
DesiredSizeGets the size that this element computed during the measure pass of the layout process. Inherited from Layoutable.
HeightGets or sets the height of the element. Inherited from Layoutable.
HorizontalAlignmentGets or sets the element's preferred horizontal alignment in its parent. Inherited from Layoutable.
IsArrangeValidGets a value indicating whether the control's layouts arrange is valid. Inherited from Layoutable.
IsMeasureValidGets a value indicating whether the control's layout measure is valid. Inherited from Layoutable.
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.
UseLayoutRoundingGets or sets a value that determines whether the element should be snapped to pixel boundaries at layout time. Inherited from Layoutable.
VerticalAlignmentGets or sets the element's preferred vertical alignment in its parent. Inherited from Layoutable.
WidthGets or sets the width of the element. Inherited from Layoutable.
BoundsGets the bounds of the control relative to its parent. Inherited from Visual.
CacheModeGets or sets the cache mode of the visual. Inherited from Visual.
ClipGets or sets the geometry clip for this visual. Inherited from Visual.
ClipToBoundsGets or sets a value indicating whether the control should be clipped to its bounds. Inherited from Visual.
EffectGets or sets the effect of the control. Inherited from Visual.
FlowDirectionGets or sets the text flow direction. Inherited from Visual.
HasMirrorTransformGets or sets a value indicating whether to apply mirror transform on this control. Inherited from Visual.
IsEffectivelyVisibleGets a value indicating whether this control and all its parents are visible. Inherited from Visual.
IsVisibleGets or sets a value indicating whether this control is visible. Inherited from Visual.
OpacityGets or sets the opacity of the control. Inherited from Visual.
OpacityMaskGets or sets the opacity mask of the control. Inherited from Visual.
RenderTransformGets or sets the render transform of the control. Inherited from Visual.
RenderTransformOriginGets or sets the transform origin of the control. Inherited from Visual.
ZIndexGets or sets the Z index of the control. Inherited from Visual.
ActualThemeVariantGets the UI theme that is currently used by the element, which might be different than the RequestedThemeVariantProperty. Inherited from StyledElement.
ClassesGets or sets the styled element's classes. Inherited from StyledElement.
DataContextGets or sets the control's data context. Inherited from StyledElement.
IsInitializedGets a value that indicates whether the element has finished initialization. Inherited from StyledElement.
NameGets or sets the name of the styled element. Inherited from StyledElement.
ParentGets the styled element's logical parent. Inherited from StyledElement.
ResourcesGets or sets the styled element's resource dictionary. Inherited from StyledElement.
StyleKeyGets the type by which the element is styled. Inherited from StyledElement.
StylesGets the styles for the styled element. Inherited from StyledElement.
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.
DispatcherReturns the Avalonia.AvaloniaObject.Dispatcher that this Avalonia.AvaloniaObject is associated with. Inherited from AvaloniaObject.
ItemInherited from AvaloniaObject.

ActualTransparencyLevel Property

Gets the achieved Avalonia.Controls.WindowTransparencyLevel that the platform was able to provide.

public Avalonia.Controls.WindowTransparencyLevel ActualTransparencyLevel { get; set; }

ClientSize Property

Gets or sets the client size of the window.

public Avalonia.Size ClientSize { get; set; }

Clipboard Property

Gets the platform's clipboard implementation

public Avalonia.Input.Platform.IClipboard Clipboard { get; set; }

FocusManager Property

Gets focus manager of the root.

public Avalonia.Input.IFocusManager FocusManager { get; set; }

Remarks

Focus manager can be null only if window wasn't initialized yet.

FrameSize Property

Gets or sets the total size of the window.

public Nullable<Avalonia.Size> FrameSize { get; set; }

InputPane Property

public Avalonia.Controls.Platform.IInputPane InputPane { get; set; }

InsetsManager Property

public Avalonia.Controls.Platform.IInsetsManager InsetsManager { get; set; }

Launcher Property

public Avalonia.Platform.Storage.ILauncher Launcher { get; set; }

PlatformImpl Property

Gets the platform-specific window implementation.

public Avalonia.Platform.ITopLevelImpl PlatformImpl { get; set; }

RenderScaling Property

public double RenderScaling { get; set; }

RendererDiagnostics Property

Gets a value indicating whether the renderer should draw specific diagnostics.

public Avalonia.Rendering.RendererDiagnostics RendererDiagnostics { get; set; }

RequestedThemeVariant Property

Gets 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.

public Avalonia.Styling.ThemeVariant RequestedThemeVariant { get; set; }

Remarks

Setting RequestedThemeVariant to Avalonia.Styling.ThemeVariant.Default will apply parent's actual theme variant on the current scope.

Screens Property

Gets platform screens implementation.

public Avalonia.Controls.Screens Screens { get; set; }

StorageProvider Property

File System storage service used for file pickers and bookmarks.

public Avalonia.Platform.Storage.IStorageProvider StorageProvider { get; set; }

TransparencyBackgroundFallback Property

Gets or sets the Avalonia.Media.IBrush that transparency will blend with when transparency is not supported. By default this is a solid white brush.

public Avalonia.Media.IBrush TransparencyBackgroundFallback { get; set; }

TransparencyLevelHint Property

Gets or sets the Avalonia.Controls.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".

public System.Collections.Generic.IReadOnlyList<Avalonia.Controls.WindowTransparencyLevel> TransparencyLevelHint { get; set; }

Fields

NameDescription
ActualThemeVariantPropertyNo summary available.
ActualTransparencyLevelPropertyDefines the Avalonia.Controls.TopLevel.ActualTransparencyLevel property.
AutoSafeAreaPaddingPropertyDefines the AutoSafeAreaPadding attached property.
BackRequestedEventDefines the Avalonia.Controls.TopLevel.BackRequested event.
ClientSizePropertyDefines the Avalonia.Controls.TopLevel.ClientSize property.
FrameSizePropertyDefines the Avalonia.Controls.TopLevel.FrameSize property.
RequestedThemeVariantPropertyNo summary available.
SystemBarColorPropertyDefines the SystemBarColor attached property.
TransparencyBackgroundFallbackPropertyDefines the Avalonia.Controls.TopLevel.TransparencyBackgroundFallback property.
TransparencyLevelHintPropertyDefines the Avalonia.Controls.TopLevel.TransparencyLevelHint property.
ContentPropertyDefines the Avalonia.Controls.ContentControl.Content property. Inherited from ContentControl.
ContentTemplatePropertyDefines the Avalonia.Controls.ContentControl.ContentTemplate property. Inherited from ContentControl.
HorizontalContentAlignmentPropertyDefines the Avalonia.Controls.ContentControl.HorizontalContentAlignment property. Inherited from ContentControl.
VerticalContentAlignmentPropertyDefines the Avalonia.Controls.ContentControl.VerticalContentAlignment property. Inherited from ContentControl.
BackgroundPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.Background property. Inherited from TemplatedControl.
BackgroundSizingPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.BackgroundSizing property. Inherited from TemplatedControl.
BorderBrushPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.BorderBrush property. Inherited from TemplatedControl.
BorderThicknessPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.BorderThickness property. Inherited from TemplatedControl.
CornerRadiusPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.CornerRadius property. Inherited from TemplatedControl.
FontFamilyPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.FontFamily property. Inherited from TemplatedControl.
FontFeaturesPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.FontFeaturesProperty property. Inherited from TemplatedControl.
FontSizePropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.FontSize property. Inherited from TemplatedControl.
FontStretchPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.FontWeight property. Inherited from TemplatedControl.
FontStylePropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.FontStyle property. Inherited from TemplatedControl.
FontWeightPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.FontWeight property. Inherited from TemplatedControl.
ForegroundPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.Foreground property. Inherited from TemplatedControl.
IsTemplateFocusTargetPropertyDefines the IsTemplateFocusTarget attached property. Inherited from TemplatedControl.
LetterSpacingPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.LetterSpacing property. Inherited from TemplatedControl.
PaddingPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.Padding property. Inherited from TemplatedControl.
TemplateAppliedEventDefines the Avalonia.Controls.Primitives.TemplatedControl.TemplateApplied routed event. Inherited from TemplatedControl.
TemplatePropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.Template property. Inherited from TemplatedControl.
ContextFlyoutPropertyDefines the Avalonia.Controls.Control.ContextFlyout property Inherited from Control.
ContextMenuPropertyDefines the Avalonia.Controls.Control.ContextMenu property. Inherited from Control.
FocusAdornerPropertyDefines the Avalonia.Controls.Control.FocusAdorner property. Inherited from Control.
LoadedEventDefines the Avalonia.Controls.Control.Loaded event. Inherited from Control.
RequestBringIntoViewEventEvent raised when an element wishes to be scrolled into view. Inherited from Control.
SizeChangedEventDefines the Avalonia.Controls.Control.SizeChanged event. Inherited from Control.
TagPropertyDefines the Avalonia.Controls.Control.Tag property. Inherited from Control.
UnloadedEventDefines the Avalonia.Controls.Control.Unloaded event. Inherited from Control.
ContextCanceledEventProvides event data for the Avalonia.Input.InputElement.ContextCanceled event. Inherited from InputElement.
ContextRequestedEventProvides event data for the Avalonia.Input.InputElement.ContextRequested event. Inherited from InputElement.
CursorPropertyGets or sets associated mouse cursor. Inherited from InputElement.
DoubleTappedEventDefines the Avalonia.Input.InputElement.DoubleTapped event. Inherited from InputElement.
FocusablePropertyDefines the Avalonia.Input.InputElement.Focusable property. Inherited from InputElement.
GettingFocusEventDefines the Avalonia.Input.InputElement.GettingFocus event. Inherited from InputElement.
GotFocusEventDefines the Avalonia.Input.InputElement.GotFocus event. Inherited from InputElement.
HoldingEventDefines the Avalonia.Input.InputElement.Holding event. Inherited from InputElement.
IsEffectivelyEnabledPropertyDefines the Avalonia.Input.InputElement.IsEffectivelyEnabled property. Inherited from InputElement.
IsEnabledPropertyDefines the Avalonia.Input.InputElement.IsEnabled property. Inherited from InputElement.
IsFocusedPropertyDefines the Avalonia.Input.InputElement.IsFocused property. Inherited from InputElement.
IsHitTestVisiblePropertyDefines the Avalonia.Input.InputElement.IsHitTestVisible property. Inherited from InputElement.
IsHoldWithMouseEnabledPropertyDefines the IsHoldWithMouseEnabled attached property. Inherited from InputElement.
IsHoldingEnabledPropertyDefines the IsHoldingEnabled attached property. Inherited from InputElement.
IsKeyboardFocusWithinPropertyDefines the Avalonia.Input.InputElement.IsKeyboardFocusWithin property. Inherited from InputElement.
IsPointerOverPropertyDefines the Avalonia.Input.InputElement.IsPointerOver property. Inherited from InputElement.
IsTabStopPropertyDefines the Avalonia.Input.InputElement.IsTabStop property. Inherited from InputElement.
KeyDownEventDefines the Avalonia.Input.InputElement.KeyDown event. Inherited from InputElement.
KeyUpEventDefines the Avalonia.Input.InputElement.KeyUp event. Inherited from InputElement.
LosingFocusEventDefines the Avalonia.Input.InputElement.LosingFocus event. Inherited from InputElement.
LostFocusEventDefines the Avalonia.Input.InputElement.LostFocus event. Inherited from InputElement.
PinchEndedEventDefines the Avalonia.Input.InputElement.PinchEnded event. Inherited from InputElement.
PinchEventDefines the Avalonia.Input.InputElement.Pinch event. Inherited from InputElement.
PointerCaptureLostEventDefines the Avalonia.Input.InputElement.PointerCaptureLost routed event. Inherited from InputElement.
PointerEnteredEventDefines the Avalonia.Input.InputElement.PointerEntered event. Inherited from InputElement.
PointerExitedEventDefines the Avalonia.Input.InputElement.PointerExited event. Inherited from InputElement.
PointerMovedEventDefines the Avalonia.Input.InputElement.PointerMoved event. Inherited from InputElement.
PointerPressedEventDefines the Avalonia.Input.InputElement.PointerPressed event. Inherited from InputElement.
PointerReleasedEventDefines the Avalonia.Input.InputElement.PointerReleased event. Inherited from InputElement.
PointerTouchPadGestureMagnifyEventDefines the Avalonia.Input.InputElement.PointerTouchPadGestureMagnify event. Inherited from InputElement.
PointerTouchPadGestureRotateEventDefines the Avalonia.Input.InputElement.PointerTouchPadGestureRotate event. Inherited from InputElement.
PointerTouchPadGestureSwipeEventDefines the Avalonia.Input.InputElement.PointerTouchPadGestureSwipe event. Inherited from InputElement.
PointerWheelChangedEventDefines the Avalonia.Input.InputElement.PointerWheelChanged event. Inherited from InputElement.
PullGestureEndedEventDefines the Avalonia.Input.InputElement.PullGestureEnded event. Inherited from InputElement.
PullGestureEventDefines the Avalonia.Input.InputElement.PullGesture event. Inherited from InputElement.
RightTappedEventDefines the Avalonia.Input.InputElement.RightTapped event. Inherited from InputElement.
ScrollGestureEndedEventDefines the Avalonia.Input.InputElement.ScrollGestureEnded event. Inherited from InputElement.
ScrollGestureEventDefines the Avalonia.Input.InputElement.ScrollGesture event. Inherited from InputElement.
ScrollGestureInertiaStartingEventDefines the Avalonia.Input.InputElement.ScrollGestureInertiaStarting event. Inherited from InputElement.
SwipeGestureEventDefines the Avalonia.Input.InputElement.SwipeGesture event. Inherited from InputElement.
TabIndexPropertyDefines the Avalonia.Input.InputElement.TabIndex property. Inherited from InputElement.
TappedEventDefines the Avalonia.Input.InputElement.Tapped event. Inherited from InputElement.
TextInputEventDefines the Avalonia.Input.InputElement.TextInput event. Inherited from InputElement.
TextInputMethodClientRequestedEventDefines the Avalonia.Input.InputElement.TextInputMethodClientRequested event. Inherited from InputElement.
DesiredSizePropertyDefines the Avalonia.Layout.Layoutable.DesiredSize property. Inherited from Layoutable.
HeightPropertyDefines the Avalonia.Layout.Layoutable.Height property. Inherited from Layoutable.
HorizontalAlignmentPropertyDefines the Avalonia.Layout.Layoutable.HorizontalAlignment property. Inherited from Layoutable.
MarginPropertyDefines the Avalonia.Layout.Layoutable.Margin property. Inherited from Layoutable.
MaxHeightPropertyDefines the Avalonia.Layout.Layoutable.MaxHeight property. Inherited from Layoutable.
MaxWidthPropertyDefines the Avalonia.Layout.Layoutable.MaxWidth property. Inherited from Layoutable.
MinHeightPropertyDefines the Avalonia.Layout.Layoutable.MinHeight property. Inherited from Layoutable.
MinWidthPropertyDefines the Avalonia.Layout.Layoutable.MinWidth property. Inherited from Layoutable.
UseLayoutRoundingPropertyDefines the Avalonia.Layout.Layoutable.UseLayoutRounding property. Inherited from Layoutable.
VerticalAlignmentPropertyDefines the Avalonia.Layout.Layoutable.VerticalAlignment property. Inherited from Layoutable.
WidthPropertyDefines the Avalonia.Layout.Layoutable.Width property. Inherited from Layoutable.
BoundsPropertyDefines the Avalonia.Visual.Bounds property. Inherited from Visual.
CacheModePropertyDefines the Avalonia.Visual.CacheMode property. Inherited from Visual.
ClipPropertyDefines the Avalonia.Visual.Clip property. Inherited from Visual.
ClipToBoundsPropertyDefines the Avalonia.Visual.ClipToBounds property. Inherited from Visual.
EffectPropertyDefines the Avalonia.Visual.Effect property. Inherited from Visual.
FlowDirectionPropertyDefines the Avalonia.Visual.FlowDirection property. Inherited from Visual.
HasMirrorTransformPropertyDefines the Avalonia.Visual.HasMirrorTransform property. Inherited from Visual.
IsVisiblePropertyDefines the Avalonia.Visual.IsVisible property. Inherited from Visual.
OpacityMaskPropertyDefines the Avalonia.Visual.OpacityMask property. Inherited from Visual.
OpacityPropertyDefines the Avalonia.Visual.Opacity property. Inherited from Visual.
RenderTransformOriginPropertyDefines the Avalonia.Visual.RenderTransformOrigin property. Inherited from Visual.
RenderTransformPropertyDefines the Avalonia.Visual.RenderTransform property. Inherited from Visual.
VisualParentPropertyDefines the Avalonia.Visual.VisualParent property. Inherited from Visual.
ZIndexPropertyDefines the Avalonia.Visual.ZIndex property. Inherited from Visual.
DataContextPropertyDefines the Avalonia.StyledElement.DataContext property. Inherited from StyledElement.
NamePropertyDefines the Avalonia.StyledElement.Name property. Inherited from StyledElement.
ParentPropertyDefines the Avalonia.StyledElement.Parent property. Inherited from StyledElement.
TemplatedParentPropertyDefines the Avalonia.StyledElement.TemplatedParent property. Inherited from StyledElement.
ThemePropertyDefines the Avalonia.StyledElement.Theme property. Inherited from StyledElement.
TransitionsPropertyDefines the Avalonia.Animation.Animatable.Transitions property. Inherited from Animatable.

ActualThemeVariantProperty Field

public Avalonia.StyledProperty<Avalonia.Styling.ThemeVariant> ActualThemeVariantProperty

ActualTransparencyLevelProperty Field

Defines the Avalonia.Controls.TopLevel.ActualTransparencyLevel property.

public Avalonia.DirectProperty<Avalonia.Controls.TopLevel, Avalonia.Controls.WindowTransparencyLevel> ActualTransparencyLevelProperty

AutoSafeAreaPaddingProperty Field

Defines the AutoSafeAreaPadding attached property.

public Avalonia.AttachedProperty<bool> AutoSafeAreaPaddingProperty

BackRequestedEvent Field

Defines the Avalonia.Controls.TopLevel.BackRequested event.

public Avalonia.Interactivity.RoutedEvent<Avalonia.Interactivity.RoutedEventArgs> BackRequestedEvent

ClientSizeProperty Field

Defines the Avalonia.Controls.TopLevel.ClientSize property.

public Avalonia.DirectProperty<Avalonia.Controls.TopLevel, Avalonia.Size> ClientSizeProperty

FrameSizeProperty Field

Defines the Avalonia.Controls.TopLevel.FrameSize property.

public Avalonia.DirectProperty<Avalonia.Controls.TopLevel, Nullable<Avalonia.Size>> FrameSizeProperty

RequestedThemeVariantProperty Field

public Avalonia.StyledProperty<Avalonia.Styling.ThemeVariant> RequestedThemeVariantProperty

SystemBarColorProperty Field

Defines the SystemBarColor attached property.

public Avalonia.AttachedProperty<Avalonia.Media.SolidColorBrush> SystemBarColorProperty

TransparencyBackgroundFallbackProperty Field

Defines the Avalonia.Controls.TopLevel.TransparencyBackgroundFallback property.

public Avalonia.StyledProperty<Avalonia.Media.IBrush> TransparencyBackgroundFallbackProperty

TransparencyLevelHintProperty Field

Defines the Avalonia.Controls.TopLevel.TransparencyLevelHint property.

public Avalonia.StyledProperty<System.Collections.Generic.IReadOnlyList<Avalonia.Controls.WindowTransparencyLevel>> TransparencyLevelHintProperty

Events

NameDescription
BackRequestedOccurs when physical Back Button is pressed or a back navigation has been requested.
ClosedFired when the window is closed.
OpenedFired when the window is opened.
ScalingChangedGets or sets a method called when the TopLevel's scaling changes.
TemplateAppliedRaised when the control's template is applied. Inherited from TemplatedControl.
LoadedOccurs when the control has been fully constructed in the visual tree and both layout and render are complete. Inherited from Control.
SizeChangedOccurs when the bounds (actual size) of the control have changed. Inherited from Control.
UnloadedOccurs when the control is removed from the visual tree. Inherited from Control.
ContextCanceledOccurs when the context input gesture continues into another gesture, to notify the element that the context flyout should not be opened. Inherited from InputElement.
ContextRequestedOccurs when the user has completed a context input gesture, such as a right-click. Inherited from InputElement.
DoubleTappedOccurs when a double-tap gesture occurs on the control. Inherited from InputElement.
GettingFocusOccurs before the control receives focus. Inherited from InputElement.
GotFocusOccurs when the control receives focus. Inherited from InputElement.
HoldingOccurs when a hold gesture occurs on the control. Inherited from InputElement.
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.
LosingFocusOccurs before the control loses focus. Inherited from InputElement.
LostFocusOccurs when the control loses focus. Inherited from InputElement.
PinchOccurs when a pinch gesture occurs on the control. Inherited from InputElement.
PinchEndedOccurs when a pinch gesture ends on the control. Inherited from InputElement.
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.
PointerTouchPadGestureMagnifyOccurs when a touchpad magnify gesture occurs on the control. Inherited from InputElement.
PointerTouchPadGestureRotateOccurs when a touchpad rotate gesture occurs on the control. Inherited from InputElement.
PointerTouchPadGestureSwipeOccurs when a touchpad swipe gesture occurs on the control. Inherited from InputElement.
PointerWheelChangedOccurs when the mouse is scrolled over the control. Inherited from InputElement.
PullGestureOccurs when a pull gesture occurs on the control. Inherited from InputElement.
PullGestureEndedOccurs when a pull gesture ends on the control. Inherited from InputElement.
RightTappedOccurs when a right tap gesture occurs on the control. Inherited from InputElement.
ScrollGestureOccurs when a scroll gesture occurs on the control. Inherited from InputElement.
ScrollGestureEndedOccurs when a scroll gesture ends on the control. Inherited from InputElement.
ScrollGestureInertiaStartingOccurs when a scroll gesture inertia starts on the control. Inherited from InputElement.
SwipeGestureOccurs when a swipe gesture occurs on the control. Inherited from InputElement.
TappedOccurs when a tap gesture occurs on the control. Inherited from InputElement.
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.
EffectiveViewportChangedOccurs when the element's effective viewport changes. Inherited from Layoutable.
LayoutUpdatedOccurs when a layout pass completes for the control. Inherited from Layoutable.
AttachedToVisualTreeRaised when the control is attached to a rooted visual tree. Inherited from Visual.
DetachedFromVisualTreeRaised when the control is detached from a rooted visual tree. Inherited from Visual.
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.
DataContextChangedOccurs when the Avalonia.StyledElement.DataContext property changes. Inherited from StyledElement.
DetachedFromLogicalTreeRaised when the styled element is detached from a rooted logical tree. Inherited from StyledElement.
InitializedOccurs when the styled element has finished initialization. Inherited from StyledElement.
ResourcesChangedOccurs when a resource in this styled element or a parent styled element has changed. Inherited from StyledElement.
PropertyChangedRaised when a Avalonia.AvaloniaProperty value changes on this object. Inherited from AvaloniaObject.

BackRequested Event

Occurs when physical Back Button is pressed or a back navigation has been requested.

public event EventHandler<Avalonia.Interactivity.RoutedEventArgs> BackRequested

Closed Event

Fired when the window is closed.

public event EventHandler Closed

Opened Event

Fired when the window is opened.

public event EventHandler Opened

ScalingChanged Event

Gets or sets a method called when the TopLevel's scaling changes.

public event EventHandler ScalingChanged