Popup Class
Displays a popup window.
Definition
Namespace: Avalonia.Controls.Primitives
Assembly: Avalonia.Controls (in Avalonia.Controls.dll)
- C#
- VB
- F#
public class Popup : Control, IPopupHostProvider
Public Class Popup
Inherits Control
Implements IPopupHostProvider
type Popup =
class
inherit Control
interface IPopupHostProvider
end
Inheritance | Object → AvaloniaObject → Animatable → StyledElement → Visual → Layoutable → Interactive → InputElement → Control → Popup |
Implements | IPopupHostProvider |
Constructors
Popup() | Initializes a new instance of the Popup class |
Properties
ActualThemeVariant | Gets the UI theme that is currently used by the element, which might be different than the RequestedThemeVariantProperty. (Inherited from StyledElement) |
Bounds | Gets the bounds of the control relative to its parent. (Inherited from Visual) |
BypassFlowDirectionPolicies | Gets a value indicating whether control bypass FlowDirecton policies. (Inherited from Visual) |
Child | Gets or sets the control to display in the popup. |
Classes | Gets or sets the styled element's classes. (Inherited from StyledElement) |
Clip | Gets or sets the geometry clip for this visual. (Inherited from Visual) |
ClipToBounds | Gets or sets a value indicating whether the control should be clipped to its bounds. (Inherited from Visual) |
ContextFlyout | Gets or sets a context flyout to the control (Inherited from Control) |
ContextMenu | Gets or sets a context menu to the control. (Inherited from Control) |
Cursor | Gets or sets associated mouse cursor. (Inherited from InputElement) |
CustomPopupPlacementCallback | Gets or sets a delegate handler method that positions the Popup control, when Placement is set to Custom. |
DataContext | Gets or sets the control's data context. (Inherited from StyledElement) |
DataTemplates | Gets or sets the data templates for the control. (Inherited from Control) |
DependencyResolver | Gets or sets a dependency resolver for the PopupRoot. |
DesiredSize | Gets the size that this element computed during the measure pass of the layout process. (Inherited from Layoutable) |
Effect | Gets or sets the effect of the control. (Inherited from Visual) |
FlowDirection | Gets or sets the text flow direction. (Inherited from Visual) |
Focusable | Gets or sets a value indicating whether the control can receive focus. (Inherited from InputElement) |
FocusAdorner | Gets or sets the control's focus adorner. (Inherited from Control) |
GestureRecognizers | (Inherited from InputElement) |
HasMirrorTransform | Gets or sets a value indicating whether to apply mirror transform on this control. (Inherited from Visual) |
Height | Gets or sets the height of the element. (Inherited from Layoutable) |
HorizontalAlignment | Gets or sets the element's preferred horizontal alignment in its parent. (Inherited from Layoutable) |
HorizontalOffset | Gets or sets the Horizontal offset of the popup in relation to the PlacementTarget. |
Host | |
InheritanceParent | Gets or sets the parent object that inherited AvaloniaProperty values are inherited from. (Inherited from AvaloniaObject) |
InheritsTransform | Gets or sets a value that determines whether the popup inherits the render transform from its PlacementTarget. Defaults to false. |
IsArrangeValid | Gets a value indicating whether the control's layouts arrange is valid. (Inherited from Layoutable) |
IsEffectivelyEnabled | Gets a value indicating whether this control and all its parents are enabled. (Inherited from InputElement) |
IsEffectivelyVisible | Gets a value indicating whether this control and all its parents are visible. (Inherited from Visual) |
IsEnabled | Gets or sets a value indicating whether the control is enabled for user interaction. (Inherited from InputElement) |
IsEnabledCore | Allows a derived class to override the enabled state of the control. (Inherited from InputElement) |
IsFocused | Gets a value indicating whether the control is focused. (Inherited from InputElement) |
IsHitTestVisible | Gets or sets a value indicating whether the control is considered for hit testing. (Inherited from InputElement) |
IsInitialized | Gets a value that indicates whether the element has finished initialization. (Inherited from StyledElement) |
IsKeyboardFocusWithin | Gets a value indicating whether keyboard focus is anywhere within the element or its visual tree child elements. (Inherited from InputElement) |
IsLightDismissEnabled | Gets or sets a value that determines how the Popup can be dismissed. |
IsLoaded | Gets a value indicating whether the control is fully constructed in the visual tree and both layout and render are complete. (Inherited from Control) |
IsMeasureValid | Gets a value indicating whether the control's layout measure is valid. (Inherited from Layoutable) |
IsOpen | Gets or sets a value indicating whether the popup is currently open. |
IsPointerOver | Gets a value indicating whether the pointer is currently over the control. (Inherited from InputElement) |
IsPointerOverPopup | |
IsTabStop | Gets or sets a value that indicates whether the control is included in tab navigation. (Inherited from InputElement) |
IsVisible | Gets or sets a value indicating whether this control is visible. (Inherited from Visual) |
Item(AvaloniaProperty) | Gets or sets the value of a AvaloniaProperty. (Inherited from AvaloniaObject) |
Item(IndexerDescriptor) | Gets or sets a binding for a AvaloniaProperty. (Inherited from AvaloniaObject) |
KeyBindings | (Inherited from InputElement) |
LogicalChildren | Gets the styled element's logical children. (Inherited from StyledElement) |
Margin | Gets or sets the margin around the element. (Inherited from Layoutable) |
MaxHeight | Gets or sets the maximum height of the element. (Inherited from Layoutable) |
MaxWidth | Gets or sets the maximum width of the element. (Inherited from Layoutable) |
MinHeight | Gets or sets the minimum height of the element. (Inherited from Layoutable) |
MinWidth | Gets or sets the minimum width of the element. (Inherited from Layoutable) |
Name | Gets or sets the name of the styled element. (Inherited from StyledElement) |
Opacity | Gets or sets the opacity of the control. (Inherited from Visual) |
OpacityMask | Gets or sets the opacity mask of the control. (Inherited from Visual) |
OverlayDismissEventPassThrough | Gets or sets a value indicating whether the event that closes the popup is passed through to the parent window. |
OverlayInputPassThroughElement | Gets or sets an element that should receive pointer input events even when underneath the popup's overlay. |
Parent | Gets the styled element's logical parent. (Inherited from StyledElement) |
Placement | Gets or sets the desired placement of the popup in relation to the PlacementTarget. |
PlacementAnchor | Gets or sets the anchor point on the PlacementRect when Placement is AnchorAndGravity. |
PlacementConstraintAdjustment | 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. |
PlacementGravity | Gets or sets a value which defines in what direction the popup should open when Placement is AnchorAndGravity. |
PlacementRect | Gets or sets the anchor rectangle within the parent that the popup will be placed relative to when Placement is AnchorAndGravity. |
PlacementTarget | Gets or sets the control that is used to determine the popup's position. |
PseudoClasses | Gets the Classes collection in a form that allows adding and removing pseudoclasses. (Inherited from StyledElement) |
RenderTransform | Gets or sets the render transform of the control. (Inherited from Visual) |
RenderTransformOrigin | Gets or sets the transform origin of the control. (Inherited from Visual) |
Resources | Gets or sets the styled element's resource dictionary. (Inherited from StyledElement) |
StyleKey | Gets the type by which the element is styled. (Inherited from StyledElement) |
StyleKeyOverride | Gets the type by which the element is styled. (Inherited from StyledElement) |
Styles | Gets the styles for the styled element. (Inherited from StyledElement) |
TabIndex | Gets 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) |
Tag | Gets or sets a user-defined object attached to the control. (Inherited from Control) |
TakesFocusFromNativeControl | Gets or sets a value indicating whether the popup, on show, transfers focus from any focused native control to Avalonia. The default is true . |
TemplatedParent | Gets the styled element whose lookless template this styled element is part of. (Inherited from StyledElement) |
Theme | Gets or sets the theme to be applied to the element. (Inherited from StyledElement) |
Topmost | Gets or sets whether this popup appears on top of all other windows |
Transitions | Gets or sets the property transitions for the control. (Inherited from Animatable) |
UseLayoutRounding | Gets or sets a value that determines whether the element should be snapped to pixel boundaries at layout time. (Inherited from Layoutable) |
VerticalAlignment | Gets or sets the element's preferred vertical alignment in its parent. (Inherited from Layoutable) |
VerticalOffset | Gets or sets the Vertical offset of the popup in relation to the PlacementTarget. |
VisualChildren | Gets the control's child visuals. (Inherited from Visual) |
VisualRoot | Gets the root of the visual tree, if the control is attached to a visual tree. (Inherited from Visual) |
Width | Gets or sets the width of the element. (Inherited from Layoutable) |
WindowManagerAddShadowHint | Gets or sets a hint to the window manager that a shadow should be added to the popup. |
ZIndex | Gets or sets the Z index of the control. (Inherited from Visual) |
Methods
Events
ActualThemeVariantChanged | Raised when the theme variant is changed on the element or an ancestor of the element. (Inherited from StyledElement) |
AttachedToLogicalTree | Raised when the styled element is attached to a rooted logical tree. (Inherited from StyledElement) |
AttachedToVisualTree | Raised when the control is attached to a rooted visual tree. (Inherited from Visual) |
Closed | Raised when the popup closes. |
ContextRequested | Occurs when the user has completed a context input gesture, such as a right-click. (Inherited from Control) |
DataContextChanged | Occurs when the DataContext property changes. (Inherited from StyledElement) |
DetachedFromLogicalTree | Raised when the styled element is detached from a rooted logical tree. (Inherited from StyledElement) |
DetachedFromVisualTree | Raised when the control is detached from a rooted visual tree. (Inherited from Visual) |
DoubleTapped | Occurs when a double-tap gesture occurs on the control. (Inherited from InputElement) |
EffectiveViewportChanged | Occurs when the element's effective viewport changes. (Inherited from Layoutable) |
GotFocus | Occurs when the control receives focus. (Inherited from InputElement) |
Holding | Occurs when a hold gesture occurs on the control. (Inherited from InputElement) |
Initialized | Occurs when the styled element has finished initialization. (Inherited from StyledElement) |
KeyDown | Occurs when a key is pressed while the control has focus. (Inherited from InputElement) |
KeyUp | Occurs when a key is released while the control has focus. (Inherited from InputElement) |
LayoutUpdated | Occurs when a layout pass completes for the control. (Inherited from Layoutable) |
Loaded | Occurs when the control has been fully constructed in the visual tree and both layout and render are complete. (Inherited from Control) |
LostFocus | Occurs when the control loses focus. (Inherited from InputElement) |
Opened | Raised when the popup opens. |
PointerCaptureLost | Occurs 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) |
PointerEntered | Occurs when the pointer enters the control. (Inherited from InputElement) |
PointerExited | Occurs when the pointer leaves the control. (Inherited from InputElement) |
PointerMoved | Occurs when the pointer moves over the control. (Inherited from InputElement) |
PointerPressed | Occurs when the pointer is pressed over the control. (Inherited from InputElement) |
PointerReleased | Occurs when the pointer is released over the control. (Inherited from InputElement) |
PointerWheelChanged | Occurs when the mouse is scrolled over the control. (Inherited from InputElement) |
PropertyChanged | Raised when a AvaloniaProperty value changes on this object. (Inherited from AvaloniaObject) |
ResourcesChanged | Occurs when a resource in this styled element or a parent styled element has changed. (Inherited from StyledElement) |
SizeChanged | Occurs when the bounds (actual size) of the control have changed. (Inherited from Control) |
Tapped | Occurs when a tap gesture occurs on the control. (Inherited from InputElement) |
TextInput | Occurs when a user typed some text while the control has focus. (Inherited from InputElement) |
TextInputMethodClientRequested | Occurs when an input element gains input focus and input method is looking for the corresponding client (Inherited from InputElement) |
Unloaded | Occurs when the control is removed from the visual tree. (Inherited from Control) |