ClassPopupBase
Represents the abstract base class for popup controls that display content in an overlay above other UI elements. Provides functionality for positioning, animation, and content management for popup-style controls.
Definition
Namespace:Telerik.Maui.Controls
Assembly:Telerik.Maui.Controls.dll
Syntax:
public abstract class PopupBase : BindableObject
Inheritance: objectPopupBase
Derived Classes:
Constructors
PopupBase()
Initializes a new instance of the PopupBase class. Sets up the internal animation system and registers the instance for memory tracking.
Declaration
public PopupBase()
Fields
AnimationDurationProperty
Identifies the AnimationDuration bindable property.
Declaration
public static readonly BindableProperty AnimationDurationProperty
Field Value
BindableProperty
AnimationEasingProperty
Identifies the AnimationEasing bindable property.
Declaration
public static readonly BindableProperty AnimationEasingProperty
Field Value
BindableProperty
AnimationTypeProperty
Identifies the AnimationType bindable property.
Declaration
public static readonly BindableProperty AnimationTypeProperty
Field Value
BindableProperty
ContentProperty
Identifies the Content bindable property.
Declaration
public static readonly BindableProperty ContentProperty
Field Value
BindableProperty
ContentTemplateProperty
Identifies the ContentTemplate bindable property.
Declaration
public static readonly BindableProperty ContentTemplateProperty
Field Value
BindableProperty
HorizontalOffsetProperty
Identifies the HorizontalOffset bindable property.
Declaration
public static readonly BindableProperty HorizontalOffsetProperty
Field Value
BindableProperty
IsModalProperty
Identifies the IsModal bindable property.
Declaration
public static readonly BindableProperty IsModalProperty
Field Value
BindableProperty
IsOpenProperty
Identifies the IsOpen bindable property.
Declaration
public static readonly BindableProperty IsOpenProperty
Field Value
BindableProperty
OutsideBackgroundColorProperty
Identifies the OutsideBackgroundColor bindable property.
Declaration
public static readonly BindableProperty OutsideBackgroundColorProperty
Field Value
BindableProperty
PlacementProperty
Identifies the Placement bindable property.
Declaration
public static readonly BindableProperty PlacementProperty
Field Value
BindableProperty
PlacementTargetProperty
Identifies the PlacementTarget bindable property.
Declaration
public static readonly BindableProperty PlacementTargetProperty
Field Value
BindableProperty
VerticalOffsetProperty
Identifies the VerticalOffset bindable property.
Declaration
public static readonly BindableProperty VerticalOffsetProperty
Field Value
BindableProperty
Properties
AnimationDuration
Gets or sets the duration in milliseconds for the popup open and close animations. This value is used for both opening and closing animations when AnimationType is not None.
Declaration
public int AnimationDuration { get; set; }
Property Value
The animation duration in milliseconds. The default value is 300.
AnimationEasing
Gets or sets the easing function used for popup opening and closing animations. This determines the acceleration curve for the animation when AnimationType is not None.
Declaration
[TypeConverter(typeof(EasingTypeConverter))]
public Easing AnimationEasing { get; set; }
Property Value
Easing
The Easing function for animations. The default value is .
AnimationType
Gets or sets the type of animation used when opening and closing the popup. Different animation types provide various visual effects for showing and hiding the popup.
Declaration
public PopupAnimationType AnimationType { get; set; }
Property Value
A PopupAnimationType value that specifies the animation type. The default value is Fade.
Content
Gets or sets the content to be displayed within the popup. When both Content and ContentTemplate are set, the ContentTemplate takes precedence.
Declaration
public View Content { get; set; }
Property Value
View
The View representing the popup's content, or null
if no content is set.
ContentTemplate
Gets or sets the data template used to generate the popup content dynamically. When set, this template will be used to create the content instead of the Content property.
Declaration
public DataTemplate ContentTemplate { get; set; }
Property Value
DataTemplate
The DataTemplate used to create the popup content, or null
if no template is set.
HorizontalOffset
Gets or sets the horizontal offset of the popup from its calculated position based on the placement mode. Positive values move the popup to the right, negative values move it to the left.
Declaration
public double HorizontalOffset { get; set; }
Property Value
The horizontal offset value in device-independent units. The default value is 0.
IsModal
Gets or sets a value indicating whether the popup is modal and prevents interaction with the underlying content. When modal, the popup displays an overlay background and captures all input until closed.
Declaration
public bool IsModal { get; set; }
Property Value
true
if the popup is modal and blocks interaction with underlying content; otherwise, false
. The default value is false
.
IsOpen
Gets or sets a value indicating whether the popup is currently open and visible.
Declaration
public bool IsOpen { get; set; }
Property Value
true
if the popup is open and visible; otherwise, false
. The default value is false
.
OutsideBackgroundColor
Gets or sets the background color of the overlay area outside the popup content when the popup is modal.
This color is applied to the area that covers the underlying content when IsModal is true
.
Declaration
public Color OutsideBackgroundColor { get; set; }
Property Value
Color
The Color of the modal overlay background. The default value is .
Placement
Gets or sets the placement mode that determines how the popup is positioned relative to its placement target. The popup may be repositioned automatically to ensure it remains visible within screen bounds.
Declaration
public PlacementMode Placement { get; set; }
Property Value
A PlacementMode value that specifies the popup placement. The default value is Bottom.
PlacementTarget
Gets or sets the visual element that the popup is positioned relative to. If not set, the popup will be positioned relative to the application's main page.
Declaration
public VisualElement PlacementTarget { get; set; }
Property Value
VisualElement
The VisualElement used as the placement target, or null
to use the default placement target.
VerticalOffset
Gets or sets the vertical offset of the popup from its calculated position based on the placement mode. Positive values move the popup down, negative values move it up.
Declaration
public double VerticalOffset { get; set; }
Property Value
The vertical offset value in device-independent units. The default value is 0.