Popup Class
Definition
Displays a popup window.
public class Popup
Constructors
| Name | Description |
|---|---|
| Popup | No summary available. |
Popup Constructor
public Popup()
Methods
| Name | Description |
|---|---|
| Close | Closes the popup. |
| GetTakesFocusFromNativeControl | Gets the value of the Avalonia.Controls.Primitives.Popup.TakesFocusFromNativeControl attached property on the specified control. |
| IsInsidePopup | No summary available. |
| Open | Opens the popup. |
| SetTakesFocusFromNativeControl | Sets the value of the Avalonia.Controls.Primitives.Popup.TakesFocusFromNativeControl attached property on the specified control. |
| Focus | Focuses the control. Inherited from InputElement. |
| GetIsHoldWithMouseEnabled | Inherited from InputElement. |
| GetIsHoldingEnabled | Inherited from InputElement. |
| SetIsHoldWithMouseEnabled | Inherited from InputElement. |
| SetIsHoldingEnabled | Inherited from InputElement. |
| AddHandler (2 overloads) | Adds a handler for the specified routed event. Inherited from Interactive. |
| RaiseEvent | Raises a routed event. Inherited from Interactive. |
| RemoveHandler (2 overloads) | Removes a handler for the specified routed event. Inherited from Interactive. |
| ApplyTemplate | Creates the visual children of the control, if necessary Inherited from Layoutable. |
| Arrange | Arranges the control and its children. Inherited from Layoutable. |
| InvalidateArrange | Invalidates the arrangement of the control and queues a new layout pass. Inherited from Layoutable. |
| InvalidateMeasure | Invalidates the measurement of the control and queues a new layout pass. Inherited from Layoutable. |
| Measure | Carries out a measure of the control. Inherited from Layoutable. |
| UpdateLayout | Executes a layout pass. Inherited from Layoutable. |
| GetFlowDirection | Gets the value of the attached Avalonia.Visual.FlowDirectionProperty on a control. Inherited from Visual. |
| InvalidateVisual | Invalidates the visual and queues a repaint. Inherited from Visual. |
| Render | Renders the visual to a Avalonia.Media.DrawingContext. Inherited from Visual. |
| SetFlowDirection | Sets the value of the attached Avalonia.Visual.FlowDirectionProperty on a control. Inherited from Visual. |
| ApplyStyling | Applies styling to the control if the control is initialized and styling is not already applied. Inherited from StyledElement. |
| BeginInit | Inherited from StyledElement. |
| EndInit | Inherited from StyledElement. |
| TryGetResource | Inherited from StyledElement. |
| Bind (8 overloads) | Binds a Avalonia.AvaloniaProperty to an Avalonia.Data.BindingBase. Inherited from AvaloniaObject. |
| CheckAccess | Returns 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. |
| CoerceValue | Coerces the specified Avalonia.AvaloniaProperty. Inherited from AvaloniaObject. |
| Equals | Compares two objects using reference equality. Inherited from AvaloniaObject. |
| GetBaseValue | Inherited from AvaloniaObject. |
| GetHashCode | Gets the hash code for the object. Inherited from AvaloniaObject. |
| GetValue (3 overloads) | Gets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject. |
| IsAnimating | Checks whether a Avalonia.AvaloniaProperty is animating. Inherited from AvaloniaObject. |
| IsSet | Checks 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. |
| VerifyAccess | Checks 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
| Name | Description |
|---|---|
| Child | Gets or sets the control to display in the popup. |
| CustomPopupPlacementCallback | 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. |
| DependencyResolver | Gets or sets a dependency resolver for the Avalonia.Controls.Primitives.PopupRoot. |
| HorizontalOffset | Gets or sets the Horizontal offset of the popup in relation to the Avalonia.Controls.Primitives.Popup.PlacementTarget. |
| InheritsTransform | Gets or sets a value that determines whether the popup inherits the render transform from its Avalonia.Controls.Primitives.Popup.PlacementTarget. Defaults to false. |
| IsLightDismissEnabled | Gets or sets a value that determines how the Avalonia.Controls.Primitives.Popup can be dismissed. |
| IsOpen | Gets or sets a value indicating whether the popup is currently open. |
| IsPointerOverPopup | No summary available. |
| IsUsingOverlayLayer | Gets a value that indicates whether the popup is shown in the overlay layer of the parent window. |
| 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. |
| Placement | Gets or sets the desired placement of the popup in relation to the Avalonia.Controls.Primitives.Popup.PlacementTarget. |
| PlacementAnchor | Gets or sets the anchor point on the Avalonia.Controls.Primitives.Popup.PlacementRect when Avalonia.Controls.Primitives.Popup.Placement is Avalonia.Controls.PlacementMode.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 Avalonia.Controls.Primitives.Popup.Placement is Avalonia.Controls.PlacementMode.AnchorAndGravity. |
| PlacementRect | 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. |
| PlacementTarget | Gets or sets the control that is used to determine the popup's position. |
| ShouldUseOverlayLayer | Gets or sets a value that indicates whether the popup should be shown in the overlay layer of the parent window. |
| 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. |
| Topmost | Gets or sets whether this popup appears on top of all other windows |
| VerticalOffset | Gets or sets the Vertical offset of the popup in relation to the Avalonia.Controls.Primitives.Popup.PlacementTarget. |
| WindowManagerAddShadowHint | Gets or sets a hint to the window manager that a shadow should be added to the popup. |
| 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. |
| DataTemplates | Gets or sets the data templates for the control. Inherited from Control. |
| FocusAdorner | Gets or sets the control's focus adorner. Inherited from Control. |
| 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. |
| Tag | Gets or sets a user-defined object attached to the control. Inherited from Control. |
| Cursor | Gets or sets associated mouse cursor. Inherited from InputElement. |
| Focusable | Gets or sets a value indicating whether the control can receive focus. Inherited from InputElement. |
| GestureRecognizers | Inherited from InputElement. |
| IsEffectivelyEnabled | Gets a value indicating whether this control and all its parents are enabled. Inherited from InputElement. |
| IsEnabled | Gets or sets a value indicating whether the control is enabled for user interaction. 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. |
| IsKeyboardFocusWithin | Gets a value indicating whether keyboard focus is anywhere within the element or its visual tree child elements. Inherited from InputElement. |
| IsPointerOver | Gets a value indicating whether the pointer is currently over the control. Inherited from InputElement. |
| IsTabStop | Gets or sets a value that indicates whether the control is included in tab navigation. Inherited from InputElement. |
| KeyBindings | Inherited from InputElement. |
| 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. |
| DesiredSize | Gets the size that this element computed during the measure pass of the layout process. Inherited from Layoutable. |
| 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. |
| IsArrangeValid | Gets a value indicating whether the control's layouts arrange is valid. Inherited from Layoutable. |
| IsMeasureValid | Gets a value indicating whether the control's layout measure is valid. Inherited from Layoutable. |
| 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. |
| 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. |
| Width | Gets or sets the width of the element. Inherited from Layoutable. |
| Bounds | Gets the bounds of the control relative to its parent. Inherited from Visual. |
| CacheMode | Gets or sets the cache mode of the visual. Inherited from Visual. |
| 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. |
| Effect | Gets or sets the effect of the control. Inherited from Visual. |
| FlowDirection | Gets or sets the text flow direction. Inherited from Visual. |
| HasMirrorTransform | Gets or sets a value indicating whether to apply mirror transform on this control. Inherited from Visual. |
| IsEffectivelyVisible | Gets a value indicating whether this control and all its parents are visible. Inherited from Visual. |
| IsVisible | Gets or sets a value indicating whether this control is visible. Inherited from Visual. |
| 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. |
| 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. |
| ZIndex | Gets or sets the Z index of the control. Inherited from Visual. |
| ActualThemeVariant | Gets the UI theme that is currently used by the element, which might be different than the RequestedThemeVariantProperty. Inherited from StyledElement. |
| Classes | Gets or sets the styled element's classes. Inherited from StyledElement. |
| DataContext | Gets or sets the control's data context. Inherited from StyledElement. |
| IsInitialized | Gets a value that indicates whether the element has finished initialization. Inherited from StyledElement. |
| Name | Gets or sets the name of the styled element. Inherited from StyledElement. |
| Parent | Gets the styled element's logical parent. Inherited from StyledElement. |
| 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. |
| Styles | Gets the styles for the styled element. Inherited from StyledElement. |
| 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. |
| Transitions | Gets or sets the property transitions for the control. Inherited from Animatable. |
| Dispatcher | Returns the Avalonia.AvaloniaObject.Dispatcher that this Avalonia.AvaloniaObject is associated with. Inherited from AvaloniaObject. |
| Item | Inherited from AvaloniaObject. |
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; }