PopupFlyoutBase Class
Definition
public class PopupFlyoutBase
Constructors
| Name | Description |
|---|---|
| PopupFlyoutBase | No summary available. |
PopupFlyoutBase Constructor
public PopupFlyoutBase()
Methods
| Name | Description |
|---|---|
| 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. |
| GetAttachedFlyout | Inherited from FlyoutBase. |
| 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. |
| Hide | Hides the Flyout |
| 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. |
| SetAttachedFlyout | Inherited from FlyoutBase. |
| 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. |
| ShowAt (2 overloads) | Shows the Flyout at the given Control |
| ShowAttachedFlyout | Inherited from FlyoutBase. |
| VerifyAccess | Checks that the current thread is the UI thread and throws if not. Inherited from AvaloniaObject. |
Hide Method
Hides the Flyout
public void Hide()
ShowAt overloads
ShowAt Method
Shows the Flyout at the given Control
public void ShowAt(Avalonia.Controls.Control placementTarget)
Parameters
placementTarget Avalonia.Controls.Control
The control to show the Flyout at
ShowAt Method
Shows the Flyout for the given control at the current pointer location, as in a ContextFlyout
public void ShowAt(Avalonia.Controls.Control placementTarget, bool showAtPointer)
Parameters
placementTarget Avalonia.Controls.Control
The target control
showAtPointer bool
True to show at pointer
Properties
| Name | Description |
|---|---|
| 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. |
| Dispatcher | Returns the Avalonia.AvaloniaObject.Dispatcher that this Avalonia.AvaloniaObject is associated with. Inherited from AvaloniaObject. |
| HorizontalOffset | Gets or sets the Horizontal offset of the popup in relation to the Avalonia.Controls.Primitives.Popup.PlacementTarget. |
| IsOpen | Gets or sets whether this Flyout is currently open. Inherited from FlyoutBase. |
| Item | Inherited from AvaloniaObject. |
| OverlayDismissEventPassThrough | Gets or sets a value indicating whether the event that closes the flyout is passed through to the parent window. |
| OverlayInputPassThroughElement | Gets or sets an element that should receive pointer input events even when underneath the flyout'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. |
| Popup | No summary available. |
| ShowMode | Gets or sets the desired ShowMode |
| Target | Gets the Target used for showing the Flyout Inherited from FlyoutBase. |
| VerticalOffset | Gets or sets the Vertical offset of the popup in relation to the Avalonia.Controls.Primitives.Popup.PlacementTarget. |
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; }
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; }
OverlayDismissEventPassThrough Property
Gets or sets a value indicating whether the event that closes the flyout is passed through to the parent window.
public bool OverlayDismissEventPassThrough { get; set; }
Remarks
Clicks outside the popup cause the popup to close. When Avalonia.Controls.Primitives.PopupFlyoutBase.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 flyout'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; }
Popup Property
public Avalonia.Controls.Primitives.Popup Popup { get; set; }
ShowMode Property
Gets or sets the desired ShowMode
public Avalonia.Controls.FlyoutShowMode ShowMode { 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; }
Fields
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
OverlayDismissEventPassThroughProperty Field
Defines the Avalonia.Controls.Primitives.PopupFlyoutBase.OverlayDismissEventPassThrough property
public Avalonia.StyledProperty<bool> OverlayDismissEventPassThroughProperty
OverlayInputPassThroughElementProperty Field
Defines the Avalonia.Controls.Primitives.PopupFlyoutBase.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.PopupFlyoutBase.PlacementConstraintAdjustment property
public Avalonia.StyledProperty<Avalonia.Controls.Primitives.PopupPositioning.PopupPositionerConstraintAdjustment> PlacementConstraintAdjustmentProperty
PlacementGravityProperty Field
Defines the Avalonia.Controls.Primitives.Popup.PlacementAnchor 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
ShowModeProperty Field
Defines the Avalonia.Controls.Primitives.PopupFlyoutBase.ShowMode property
public Avalonia.StyledProperty<Avalonia.Controls.FlyoutShowMode> ShowModeProperty
VerticalOffsetProperty Field
Defines the Avalonia.Controls.Primitives.Popup.VerticalOffset property.
public Avalonia.StyledProperty<double> VerticalOffsetProperty
Events
| Name | Description |
|---|---|
| Closed | Inherited from FlyoutBase. |
| Closing | No summary available. |
| Opened | Inherited from FlyoutBase. |
| Opening | No summary available. |
| PropertyChanged | Raised when a Avalonia.AvaloniaProperty value changes on this object. Inherited from AvaloniaObject. |
Closing Event
public event EventHandler<System.ComponentModel.CancelEventArgs> Closing
Opening Event
public event EventHandler Opening