Skip to main content

Popup Class

Definition

Assembly:Avalonia.Controls
Package:Avalonia
Source:Popup.cs

Displays a popup window.

public class Popup

Inheritance: object -> AvaloniaObject -> Animatable -> StyledElement -> Visual -> Layoutable -> Interactive -> InputElement -> Control -> Popup

Implements: IPopupHostProvider

Constructors

NameDescription
PopupNo summary available.
public Popup()

Methods

NameDescription
AddHandler (2 overloads)Adds a handler for the specified routed event. Inherited from Interactive.
ApplyStylingApplies styling to the control if the control is initialized and styling is not already applied. Inherited from StyledElement.
ApplyTemplateCreates the visual children of the control, if necessary Inherited from Layoutable.
ArrangeArranges the control and its children. Inherited from Layoutable.
BeginInitInherited 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.
CloseCloses the popup.
CoerceValueCoerces the specified Avalonia.AvaloniaProperty. Inherited from AvaloniaObject.
EndInitInherited from StyledElement.
EqualsCompares two objects using reference equality. Inherited from AvaloniaObject.
FocusFocuses the control. Inherited from InputElement.
GetBaseValueInherited from AvaloniaObject.
GetFlowDirectionGets the value of the attached Avalonia.Visual.FlowDirectionProperty on a control. Inherited from Visual.
GetHashCodeGets the hash code for the object. Inherited from AvaloniaObject.
GetIsHoldingEnabledInherited from InputElement.
GetIsHoldWithMouseEnabledInherited from InputElement.
GetTakesFocusFromNativeControlGets the value of the Avalonia.Controls.Primitives.Popup.TakesFocusFromNativeControl attached property on the specified control.
GetValue (3 overloads)Gets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject.
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.
InvalidateVisualInvalidates the visual and queues a repaint. Inherited from Visual.
IsAnimatingChecks whether a Avalonia.AvaloniaProperty is animating. Inherited from AvaloniaObject.
IsInsidePopupNo summary available.
IsSetChecks whether a Avalonia.AvaloniaProperty is set on this object. Inherited from AvaloniaObject.
MeasureCarries out a measure of the control. Inherited from Layoutable.
OpenOpens the popup.
RaiseEventRaises a routed event. Inherited from Interactive.
RemoveHandler (2 overloads)Removes a handler for the specified routed event. Inherited from Interactive.
RenderRenders the visual to a Avalonia.Media.DrawingContext. Inherited from Visual.
SetCurrentValue (2 overloads)Sets the value of a dependency property without changing its value source. Inherited from AvaloniaObject.
SetFlowDirectionSets the value of the attached Avalonia.Visual.FlowDirectionProperty on a control. Inherited from Visual.
SetIsHoldingEnabledInherited from InputElement.
SetIsHoldWithMouseEnabledInherited from InputElement.
SetTakesFocusFromNativeControlSets the value of the Avalonia.Controls.Primitives.Popup.TakesFocusFromNativeControl attached property on the specified control.
SetValue (3 overloads)Sets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject.
TryGetResourceInherited from StyledElement.
UpdateLayoutExecutes a layout pass. Inherited from Layoutable.
VerifyAccessChecks that the current thread is the UI thread and throws if not. Inherited from AvaloniaObject.

Close Method

Closes the popup.

public void Close()

GetTakesFocusFromNativeControl Method

Gets the value of the Avalonia.Controls.Primitives.Popup.TakesFocusFromNativeControl attached property on the specified control.

public bool GetTakesFocusFromNativeControl(Avalonia.Controls.Control control)

Parameters

control Avalonia.Controls.Control

The control.

Returns

bool

IsInsidePopup Method

public bool IsInsidePopup(Avalonia.Visual visual)

Parameters

visual Avalonia.Visual

Returns

bool

Open Method

Opens the popup.

public void Open()

SetTakesFocusFromNativeControl Method

Sets the value of the Avalonia.Controls.Primitives.Popup.TakesFocusFromNativeControl attached property on the specified control.

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

Parameters

control Avalonia.Controls.Control

The control.

value bool

The value of the TakesFocusFromNativeControl property.

Properties

NameDescription
ActualThemeVariantGets the UI theme that is currently used by the element, which might be different than the RequestedThemeVariantProperty. Inherited from StyledElement.
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.
ChildGets or sets the control to display in the popup.
ClassesGets or sets the styled element's classes. Inherited from StyledElement.
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.
ContextFlyoutGets or sets a context flyout to the control Inherited from Control.
ContextMenuGets or sets a context menu to the control. Inherited from Control.
CursorGets or sets associated mouse cursor. Inherited from InputElement.
CustomPopupPlacementCallbackGets or sets a delegate handler method that positions the Popup control, when Avalonia.Controls.Primitives.Popup.Placement is set to Avalonia.Controls.PlacementMode.Custom.
DataContextGets or sets the control's data context. Inherited from StyledElement.
DataTemplatesGets or sets the data templates for the control. Inherited from Control.
DependencyResolverGets or sets a dependency resolver for the Avalonia.Controls.Primitives.PopupRoot.
DesiredSizeGets the size that this element computed during the measure pass of the layout process. Inherited from Layoutable.
DispatcherReturns the Avalonia.AvaloniaObject.Dispatcher that this Avalonia.AvaloniaObject is associated with. Inherited from AvaloniaObject.
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.
GestureRecognizersInherited 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.
HorizontalOffsetGets or sets the Horizontal offset of the popup in relation to the Avalonia.Controls.Primitives.Popup.PlacementTarget.
InheritsTransformGets or sets a value that determines whether the popup inherits the render transform from its Avalonia.Controls.Primitives.Popup.PlacementTarget. Defaults to false.
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.
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.
IsLightDismissEnabledGets or sets a value that determines how the Avalonia.Controls.Primitives.Popup can be dismissed.
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.
IsOpenGets or sets a value indicating whether the popup is currently open.
IsPointerOverGets a value indicating whether the pointer is currently over the control. Inherited from InputElement.
IsPointerOverPopupNo summary available.
IsTabStopGets or sets a value that indicates whether the control is included in tab navigation. Inherited from InputElement.
IsUsingOverlayLayerGets a value that indicates whether the popup is shown in the overlay layer of the parent window.
IsVisibleGets or sets a value indicating whether this control is visible. Inherited from Visual.
ItemInherited from AvaloniaObject.
KeyBindingsInherited from InputElement.
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.
OverlayDismissEventPassThroughGets or sets a value indicating whether the event that closes the popup is passed through to the parent window.
OverlayInputPassThroughElementGets or sets an element that should receive pointer input events even when underneath the popup's overlay.
ParentGets the styled element's logical parent. Inherited from StyledElement.
PlacementGets or sets the desired placement of the popup in relation to the Avalonia.Controls.Primitives.Popup.PlacementTarget.
PlacementAnchorGets or sets the anchor point on the Avalonia.Controls.Primitives.Popup.PlacementRect when Avalonia.Controls.Primitives.Popup.Placement is Avalonia.Controls.PlacementMode.AnchorAndGravity.
PlacementConstraintAdjustmentGets or sets a value describing how the popup position will be adjusted if the unadjusted position would result in the popup being partly constrained.
PlacementGravityGets or sets a value which defines in what direction the popup should open when Avalonia.Controls.Primitives.Popup.Placement is Avalonia.Controls.PlacementMode.AnchorAndGravity.
PlacementRectGets or sets the anchor rectangle within the parent that the popup will be placed relative to when Avalonia.Controls.Primitives.Popup.Placement is Avalonia.Controls.PlacementMode.AnchorAndGravity.
PlacementTargetGets or sets the control that is used to determine the popup's position.
RenderTransformGets or sets the render transform of the control. Inherited from Visual.
RenderTransformOriginGets or sets the transform origin of the control. Inherited from Visual.
ResourcesGets or sets the styled element's resource dictionary. Inherited from StyledElement.
ShouldUseOverlayLayerGets or sets a value that indicates whether the popup should be shown in the overlay layer of the parent window.
StyleKeyGets 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.
TakesFocusFromNativeControlGets or sets a value indicating whether the popup, on show, transfers focus from any focused native control to Avalonia. The default is true.
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.
TopmostGets or sets whether this popup appears on top of all other windows
TransitionsGets or sets the property transitions for the control. Inherited from Animatable.
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.
VerticalOffsetGets or sets the Vertical offset of the popup in relation to the Avalonia.Controls.Primitives.Popup.PlacementTarget.
WidthGets or sets the width of the element. Inherited from Layoutable.
WindowManagerAddShadowHintGets or sets a hint to the window manager that a shadow should be added to the popup.
ZIndexGets or sets the Z index of the control. Inherited from Visual.

Child Property

Gets or sets the control to display in the popup.

public Avalonia.Controls.Control Child { get; set; }

CustomPopupPlacementCallback Property

Gets or sets a delegate handler method that positions the Popup control, when Avalonia.Controls.Primitives.Popup.Placement is set to Avalonia.Controls.PlacementMode.Custom.

public Avalonia.Controls.Primitives.PopupPositioning.CustomPopupPlacementCallback CustomPopupPlacementCallback { get; set; }

DependencyResolver Property

Gets or sets a dependency resolver for the Avalonia.Controls.Primitives.PopupRoot.

public Avalonia.IAvaloniaDependencyResolver DependencyResolver { get; set; }

Remarks

This property allows a client to customize the behaviour of the popup by injecting a specialized dependency resolver into the Avalonia.Controls.Primitives.PopupRoot's constructor.

HorizontalOffset Property

Gets or sets the Horizontal offset of the popup in relation to the Avalonia.Controls.Primitives.Popup.PlacementTarget.

public double HorizontalOffset { get; set; }

InheritsTransform Property

Gets or sets a value that determines whether the popup inherits the render transform from its Avalonia.Controls.Primitives.Popup.PlacementTarget. Defaults to false.

public bool InheritsTransform { get; set; }

IsLightDismissEnabled Property

Gets or sets a value that determines how the Avalonia.Controls.Primitives.Popup can be dismissed.

public bool IsLightDismissEnabled { get; set; }

Remarks

Light dismiss is when the user taps on any area other than the popup.

IsOpen Property

Gets or sets a value indicating whether the popup is currently open.

public bool IsOpen { get; set; }

IsPointerOverPopup Property

public bool IsPointerOverPopup { get; set; }

IsUsingOverlayLayer Property

Gets a value that indicates whether the popup is shown in the overlay layer of the parent window.

public bool IsUsingOverlayLayer { get; set; }

OverlayDismissEventPassThrough Property

Gets or sets a value indicating whether the event that closes the popup is passed through to the parent window.

public bool OverlayDismissEventPassThrough { get; set; }

Remarks

When Avalonia.Controls.Primitives.Popup.IsLightDismissEnabled is set to true, clicks outside the popup cause the popup to close. When Avalonia.Controls.Primitives.Popup.OverlayDismissEventPassThrough is set to false, these clicks will be handled by the popup and not be registered by the parent window. When set to true, the events will be passed through to the parent window.

OverlayInputPassThroughElement Property

Gets or sets an element that should receive pointer input events even when underneath the popup's overlay.

public Avalonia.Input.IInputElement OverlayInputPassThroughElement { get; set; }

Placement Property

Gets or sets the desired placement of the popup in relation to the Avalonia.Controls.Primitives.Popup.PlacementTarget.

public Avalonia.Controls.PlacementMode Placement { get; set; }

PlacementAnchor Property

Gets or sets the anchor point on the Avalonia.Controls.Primitives.Popup.PlacementRect when Avalonia.Controls.Primitives.Popup.Placement is Avalonia.Controls.PlacementMode.AnchorAndGravity.

public Avalonia.Controls.Primitives.PopupPositioning.PopupAnchor PlacementAnchor { get; set; }

PlacementConstraintAdjustment Property

Gets or sets a value describing how the popup position will be adjusted if the unadjusted position would result in the popup being partly constrained.

public Avalonia.Controls.Primitives.PopupPositioning.PopupPositionerConstraintAdjustment PlacementConstraintAdjustment { get; set; }

PlacementGravity Property

Gets or sets a value which defines in what direction the popup should open when Avalonia.Controls.Primitives.Popup.Placement is Avalonia.Controls.PlacementMode.AnchorAndGravity.

public Avalonia.Controls.Primitives.PopupPositioning.PopupGravity PlacementGravity { get; set; }

PlacementRect Property

Gets or sets the anchor rectangle within the parent that the popup will be placed relative to when Avalonia.Controls.Primitives.Popup.Placement is Avalonia.Controls.PlacementMode.AnchorAndGravity.

public Nullable<Avalonia.Rect> PlacementRect { get; set; }

Remarks

The placement rect defines a rectangle relative to Avalonia.Controls.Primitives.Popup.PlacementTarget around which the popup will be opened, with Avalonia.Controls.Primitives.Popup.PlacementAnchor determining which edge of the placement target is used.

If unset, the anchor rectangle will be the bounds of the Avalonia.Controls.Primitives.Popup.PlacementTarget.

PlacementTarget Property

Gets or sets the control that is used to determine the popup's position.

public Avalonia.Controls.Control PlacementTarget { get; set; }

ShouldUseOverlayLayer Property

Gets or sets a value that indicates whether the popup should be shown in the overlay layer of the parent window.

public bool ShouldUseOverlayLayer { get; set; }

Remarks

When Avalonia.Controls.Primitives.Popup.ShouldUseOverlayLayer is "false" implementation depends on the platform. Use Avalonia.Controls.Primitives.Popup.IsUsingOverlayLayer to get actual popup behavior. This is an equvalent of OverlayPopups property of the platform options, but settable independently per each popup.

TakesFocusFromNativeControl Property

Gets or sets a value indicating whether the popup, on show, transfers focus from any focused native control to Avalonia. The default is true.

public bool TakesFocusFromNativeControl { get; set; }

Remarks

This property only applies to advanced native control embedding scenarios. By default, if a popup is shown when a native control is focused, focus is transferred back to Avalonia in order for the popup to receive input. If this property is set to false, then the shown popup will not receive input until it receives an interaction which explicitly focuses the popup, such as a mouse click.

Topmost Property

Gets or sets whether this popup appears on top of all other windows

public bool Topmost { get; set; }

VerticalOffset Property

Gets or sets the Vertical offset of the popup in relation to the Avalonia.Controls.Primitives.Popup.PlacementTarget.

public double VerticalOffset { get; set; }

WindowManagerAddShadowHint Property

Gets or sets a hint to the window manager that a shadow should be added to the popup.

public bool WindowManagerAddShadowHint { get; set; }

Fields

NameDescription
BoundsPropertyDefines the Avalonia.Visual.Bounds property. Inherited from Visual.
CacheModePropertyDefines the Avalonia.Visual.CacheMode property. Inherited from Visual.
ChildPropertyDefines the Avalonia.Controls.Primitives.Popup.Child property.
ClipPropertyDefines the Avalonia.Visual.Clip property. Inherited from Visual.
ClipToBoundsPropertyDefines the Avalonia.Visual.ClipToBounds property. Inherited from Visual.
ContextCanceledEventProvides event data for the Avalonia.Input.InputElement.ContextCanceled event. Inherited from InputElement.
ContextFlyoutPropertyDefines the Avalonia.Controls.Control.ContextFlyout property Inherited from Control.
ContextMenuPropertyDefines the Avalonia.Controls.Control.ContextMenu property. Inherited from Control.
ContextRequestedEventProvides event data for the Avalonia.Input.InputElement.ContextRequested event. Inherited from InputElement.
CursorPropertyGets or sets associated mouse cursor. Inherited from InputElement.
CustomPopupPlacementCallbackPropertyDefines the Avalonia.Controls.Primitives.Popup.CustomPopupPlacementCallback property.
DataContextPropertyDefines the Avalonia.StyledElement.DataContext property. Inherited from StyledElement.
DesiredSizePropertyDefines the Avalonia.Layout.Layoutable.DesiredSize property. Inherited from Layoutable.
DoubleTappedEventDefines the Avalonia.Input.InputElement.DoubleTapped event. Inherited from InputElement.
EffectPropertyDefines the Avalonia.Visual.Effect property. Inherited from Visual.
FlowDirectionPropertyDefines the Avalonia.Visual.FlowDirection property. Inherited from Visual.
FocusablePropertyDefines the Avalonia.Input.InputElement.Focusable property. Inherited from InputElement.
FocusAdornerPropertyDefines the Avalonia.Controls.Control.FocusAdorner property. Inherited from Control.
GettingFocusEventDefines the Avalonia.Input.InputElement.GettingFocus event. Inherited from InputElement.
GotFocusEventDefines the Avalonia.Input.InputElement.GotFocus event. Inherited from InputElement.
HasMirrorTransformPropertyDefines the Avalonia.Visual.HasMirrorTransform property. Inherited from Visual.
HeightPropertyDefines the Avalonia.Layout.Layoutable.Height property. Inherited from Layoutable.
HoldingEventDefines the Avalonia.Input.InputElement.Holding event. Inherited from InputElement.
HorizontalAlignmentPropertyDefines the Avalonia.Layout.Layoutable.HorizontalAlignment property. Inherited from Layoutable.
HorizontalOffsetPropertyDefines the Avalonia.Controls.Primitives.Popup.HorizontalOffset property.
InheritsTransformPropertyDefines the Avalonia.Controls.Primitives.Popup.InheritsTransform property.
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.
IsHoldingEnabledPropertyDefines the IsHoldingEnabled attached property. Inherited from InputElement.
IsHoldWithMouseEnabledPropertyDefines the IsHoldWithMouseEnabled attached property. Inherited from InputElement.
IsKeyboardFocusWithinPropertyDefines the Avalonia.Input.InputElement.IsKeyboardFocusWithin property. Inherited from InputElement.
IsLightDismissEnabledPropertyDefines the Avalonia.Controls.Primitives.Popup.IsLightDismissEnabled property.
IsOpenPropertyDefines the Avalonia.Controls.Primitives.Popup.IsOpen property.
IsPointerOverPropertyDefines the Avalonia.Input.InputElement.IsPointerOver property. Inherited from InputElement.
IsTabStopPropertyDefines the Avalonia.Input.InputElement.IsTabStop property. Inherited from InputElement.
IsUsingOverlayLayerPropertyDefines the Avalonia.Controls.Primitives.Popup.IsUsingOverlayLayer property.
IsVisiblePropertyDefines the Avalonia.Visual.IsVisible property. Inherited from Visual.
KeyDownEventDefines the Avalonia.Input.InputElement.KeyDown event. Inherited from InputElement.
KeyUpEventDefines the Avalonia.Input.InputElement.KeyUp event. Inherited from InputElement.
LoadedEventDefines the Avalonia.Controls.Control.Loaded event. Inherited from Control.
LosingFocusEventDefines the Avalonia.Input.InputElement.LosingFocus event. Inherited from InputElement.
LostFocusEventDefines the Avalonia.Input.InputElement.LostFocus event. Inherited from InputElement.
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.
NamePropertyDefines the Avalonia.StyledElement.Name property. Inherited from StyledElement.
OpacityMaskPropertyDefines the Avalonia.Visual.OpacityMask property. Inherited from Visual.
OpacityPropertyDefines the Avalonia.Visual.Opacity property. Inherited from Visual.
OverlayDismissEventPassThroughPropertyDefines the Avalonia.Controls.Primitives.Popup.OverlayDismissEventPassThrough property.
OverlayInputPassThroughElementPropertyDefines the Avalonia.Controls.Primitives.Popup.OverlayInputPassThroughElement property.
ParentPropertyDefines the Avalonia.StyledElement.Parent property. Inherited from StyledElement.
PinchEndedEventDefines the Avalonia.Input.InputElement.PinchEnded event. Inherited from InputElement.
PinchEventDefines the Avalonia.Input.InputElement.Pinch event. Inherited from InputElement.
PlacementAnchorPropertyDefines the Avalonia.Controls.Primitives.Popup.PlacementAnchor property.
PlacementConstraintAdjustmentPropertyDefines the Avalonia.Controls.Primitives.Popup.PlacementConstraintAdjustment property.
PlacementGravityPropertyDefines the Avalonia.Controls.Primitives.Popup.PlacementGravity property.
PlacementPropertyDefines the Avalonia.Controls.Primitives.Popup.Placement property.
PlacementRectPropertyDefines the Avalonia.Controls.Primitives.Popup.PlacementRect property.
PlacementTargetPropertyDefines the Avalonia.Controls.Primitives.Popup.PlacementTarget property.
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.
RenderTransformOriginPropertyDefines the Avalonia.Visual.RenderTransformOrigin property. Inherited from Visual.
RenderTransformPropertyDefines the Avalonia.Visual.RenderTransform property. Inherited from Visual.
RequestBringIntoViewEventEvent raised when an element wishes to be scrolled into view. Inherited from Control.
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.
ShouldUseOverlayLayerPropertyDefines the Avalonia.Controls.Primitives.Popup.ShouldUseOverlayLayer property.
SizeChangedEventDefines the Avalonia.Controls.Control.SizeChanged event. Inherited from Control.
SwipeGestureEndedEventDefines the Avalonia.Input.InputElement.SwipeGestureEnded event. Inherited from InputElement.
SwipeGestureEventDefines the Avalonia.Input.InputElement.SwipeGesture event. Inherited from InputElement.
TabIndexPropertyDefines the Avalonia.Input.InputElement.TabIndex property. Inherited from InputElement.
TagPropertyDefines the Avalonia.Controls.Control.Tag property. Inherited from Control.
TakesFocusFromNativeControlPropertyDefines the Avalonia.Controls.Primitives.Popup.TakesFocusFromNativeControl property.
TappedEventDefines the Avalonia.Input.InputElement.Tapped event. Inherited from InputElement.
TemplatedParentPropertyDefines the Avalonia.StyledElement.TemplatedParent property. Inherited from StyledElement.
TextInputEventDefines the Avalonia.Input.InputElement.TextInput event. Inherited from InputElement.
TextInputMethodClientRequestedEventDefines the Avalonia.Input.InputElement.TextInputMethodClientRequested event. Inherited from InputElement.
ThemePropertyDefines the Avalonia.StyledElement.Theme property. Inherited from StyledElement.
TopmostPropertyDefines the Avalonia.Controls.Primitives.Popup.Topmost property.
TransitionsPropertyDefines the Avalonia.Animation.Animatable.Transitions property. Inherited from Animatable.
UnloadedEventDefines the Avalonia.Controls.Control.Unloaded event. Inherited from Control.
UseLayoutRoundingPropertyDefines the Avalonia.Layout.Layoutable.UseLayoutRounding property. Inherited from Layoutable.
VerticalAlignmentPropertyDefines the Avalonia.Layout.Layoutable.VerticalAlignment property. Inherited from Layoutable.
VerticalOffsetPropertyDefines the Avalonia.Controls.Primitives.Popup.VerticalOffset property.
VisualParentPropertyDefines the Avalonia.Visual.VisualParent property. Inherited from Visual.
WidthPropertyDefines the Avalonia.Layout.Layoutable.Width property. Inherited from Layoutable.
WindowManagerAddShadowHintPropertyDefines the Avalonia.Controls.Primitives.Popup.WindowManagerAddShadowHint property.
ZIndexPropertyDefines the Avalonia.Visual.ZIndex property. Inherited from Visual.

ChildProperty Field

Defines the Avalonia.Controls.Primitives.Popup.Child property.

public Avalonia.StyledProperty<Avalonia.Controls.Control> ChildProperty

CustomPopupPlacementCallbackProperty Field

Defines the Avalonia.Controls.Primitives.Popup.CustomPopupPlacementCallback property.

public Avalonia.StyledProperty<Avalonia.Controls.Primitives.PopupPositioning.CustomPopupPlacementCallback> CustomPopupPlacementCallbackProperty

HorizontalOffsetProperty Field

Defines the Avalonia.Controls.Primitives.Popup.HorizontalOffset property.

public Avalonia.StyledProperty<double> HorizontalOffsetProperty

InheritsTransformProperty Field

Defines the Avalonia.Controls.Primitives.Popup.InheritsTransform property.

public Avalonia.StyledProperty<bool> InheritsTransformProperty

IsLightDismissEnabledProperty Field

Defines the Avalonia.Controls.Primitives.Popup.IsLightDismissEnabled property.

public Avalonia.StyledProperty<bool> IsLightDismissEnabledProperty

IsOpenProperty Field

Defines the Avalonia.Controls.Primitives.Popup.IsOpen property.

public Avalonia.StyledProperty<bool> IsOpenProperty

IsUsingOverlayLayerProperty Field

Defines the Avalonia.Controls.Primitives.Popup.IsUsingOverlayLayer property.

public Avalonia.DirectProperty<Avalonia.Controls.Primitives.Popup, bool> IsUsingOverlayLayerProperty

OverlayDismissEventPassThroughProperty Field

Defines the Avalonia.Controls.Primitives.Popup.OverlayDismissEventPassThrough property.

public Avalonia.StyledProperty<bool> OverlayDismissEventPassThroughProperty

OverlayInputPassThroughElementProperty Field

Defines the Avalonia.Controls.Primitives.Popup.OverlayInputPassThroughElement property.

public Avalonia.StyledProperty<Avalonia.Input.IInputElement> OverlayInputPassThroughElementProperty

PlacementAnchorProperty Field

Defines the Avalonia.Controls.Primitives.Popup.PlacementAnchor property.

public Avalonia.StyledProperty<Avalonia.Controls.Primitives.PopupPositioning.PopupAnchor> PlacementAnchorProperty

PlacementConstraintAdjustmentProperty Field

Defines the Avalonia.Controls.Primitives.Popup.PlacementConstraintAdjustment property.

public Avalonia.StyledProperty<Avalonia.Controls.Primitives.PopupPositioning.PopupPositionerConstraintAdjustment> PlacementConstraintAdjustmentProperty

PlacementGravityProperty Field

Defines the Avalonia.Controls.Primitives.Popup.PlacementGravity property.

public Avalonia.StyledProperty<Avalonia.Controls.Primitives.PopupPositioning.PopupGravity> PlacementGravityProperty

PlacementProperty Field

Defines the Avalonia.Controls.Primitives.Popup.Placement property.

public Avalonia.StyledProperty<Avalonia.Controls.PlacementMode> PlacementProperty

PlacementRectProperty Field

Defines the Avalonia.Controls.Primitives.Popup.PlacementRect property.

public Avalonia.StyledProperty<Nullable<Avalonia.Rect>> PlacementRectProperty

PlacementTargetProperty Field

Defines the Avalonia.Controls.Primitives.Popup.PlacementTarget property.

public Avalonia.StyledProperty<Avalonia.Controls.Control> PlacementTargetProperty

ShouldUseOverlayLayerProperty Field

Defines the Avalonia.Controls.Primitives.Popup.ShouldUseOverlayLayer property.

public Avalonia.StyledProperty<bool> ShouldUseOverlayLayerProperty

TakesFocusFromNativeControlProperty Field

Defines the Avalonia.Controls.Primitives.Popup.TakesFocusFromNativeControl property.

public Avalonia.AttachedProperty<bool> TakesFocusFromNativeControlProperty

TopmostProperty Field

Defines the Avalonia.Controls.Primitives.Popup.Topmost property.

public Avalonia.StyledProperty<bool> TopmostProperty

VerticalOffsetProperty Field

Defines the Avalonia.Controls.Primitives.Popup.VerticalOffset property.

public Avalonia.StyledProperty<double> VerticalOffsetProperty

WindowManagerAddShadowHintProperty Field

Defines the Avalonia.Controls.Primitives.Popup.WindowManagerAddShadowHint property.

public Avalonia.StyledProperty<bool> WindowManagerAddShadowHintProperty

Events

NameDescription
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.
ClosedRaised when the popup closes.
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.
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.
DetachedFromVisualTreeRaised when the control is detached from a rooted visual tree. Inherited from Visual.
DoubleTappedOccurs when the user briefly contacts and releases twice on a single point, without significant movement. Inherited from InputElement.
EffectiveViewportChangedOccurs when the element's effective viewport changes. Inherited from Layoutable.
GettingFocusOccurs before the control receives focus. Inherited from InputElement.
GotFocusOccurs when the control receives focus. Inherited from InputElement.
HoldingOccurs when the user makes a single contact, then maintains contact beyond a given time threshold without releasing or making another contact. 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.
LosingFocusOccurs before the control loses focus. Inherited from InputElement.
LostFocusOccurs when the control loses focus. Inherited from InputElement.
OpenedRaised when the popup opens.
PinchOccurs when the user moves two contact points closer together. Inherited from InputElement.
PinchEndedOccurs when the user releases both contact points used in a pinch gesture. 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 the user moves two contact points away from each other on a touchpad. Inherited from InputElement.
PointerTouchPadGestureRotateOccurs when the user places two contact points and moves them in a circular motion on a touchpad. Inherited from InputElement.
PointerTouchPadGestureSwipeOccurs when the user performs a rapid dragging motion in a single direction on a touchpad. Inherited from InputElement.
PointerWheelChangedOccurs when the mouse is scrolled over the control. Inherited from InputElement.
PropertyChangedRaised when a Avalonia.AvaloniaProperty value changes on this object. Inherited from AvaloniaObject.
PullGestureOccurs when the user drags from the edge of a control. Inherited from InputElement.
PullGestureEndedOccurs when the user releases the pointer after a pull gesture. Inherited from InputElement.
ResourcesChangedOccurs when a resource in this styled element or a parent styled element has changed. Inherited from StyledElement.
RightTappedOccurs when the user briefly contacts and releases a single point, without significant movement, using a mechanism on the input device recognized as a right button or equivalent. Inherited from InputElement.
ScrollGestureOccurs when the user continuously moves the pointer in the same direction within the control’s boundaries. Inherited from InputElement.
ScrollGestureEndedOccurs when a scroll gesture has fully stopped, taking into account any inertial movement that continues the scroll after the user has released the pointer. Inherited from InputElement.
ScrollGestureInertiaStartingOccurs within a scroll gesture, when the user releases the pointer, and scrolling continues by transitioning to momentum-based gliding movement. Inherited from InputElement.
SizeChangedOccurs when the bounds (actual size) of the control have changed. Inherited from Control.
SwipeGestureOccurs when the user rapidly drags the pointer in a single direction across the control. Inherited from InputElement.
SwipeGestureEndedOccurs when a swipe gesture ends on the control. Inherited from InputElement.
TappedOccurs when the user briefly contacts and releases a single point, without significant movement. 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.
UnloadedOccurs when the control is removed from the visual tree. Inherited from Control.

Closed Event

Raised when the popup closes.

public event EventHandler<EventArgs> Closed

Opened Event

Raised when the popup opens.

public event EventHandler Opened