Class SfPopupLayout

SfPopupLayout allows the user to display an alert message with the customizable buttons or load any desired view inside the pop-up.

Inheritance

System.Object

SfPopupLayout

Namespace: Syncfusion.iOS.PopupLayout

Assembly: Syncfusion.SfPopupLayout.iOS.dll

Syntax

public class SfPopupLayout : UIView

Constructors

SfPopupLayout()

Initializes a new instance of the SfPopupLayout class.

Declaration

public SfPopupLayout()

SfPopupLayout(CGRect)

Initializes a new instance of the SfPopupLayout class.

Declaration

public SfPopupLayout(CGRect rect)

Parameters

Type	Name	Description
CoreGraphics.CGRect	rect	The CoreGraphics.CGRect.

SfPopupLayout(IntPtr)

Initializes a new instance of the SfPopupLayout class.

Declaration

public SfPopupLayout(IntPtr ptr)

Parameters

Type	Name	Description
System.IntPtr	ptr	The System.IntPtr.

Properties

Content

Gets or sets the content of the SfPopupLayout which is the hosting view of the SfPopupLayout.

Declaration

public UIView Content { get; set; }

Property Value

Type	Description
UIKit.UIView	The content of the SfPopupLayout.

Remarks

The PopupView will be hosted inside the view which is set as the Content.

IsOpen

Gets or sets a value indicating whether the PopupView is open or not.

Declaration

public bool IsOpen { get; set; }

Property Value

Type	Description
System.Boolean	The value indicating whether the PopupView is open or not.

Remarks

The PopupView will be opened and closed based on this value.

PopupView

Gets or sets the popup view of the SfPopupLayout that will be displayed when setting the IsOpen property as true.

Declaration

public PopupView PopupView { get; }

Property Value

Type	Description
PopupView	The popup view of the SfPopupLayout that will be displayed when setting the IsOpen property as true.

ShowOverlayAlways

Gets or sets a value indicating whether an overlay can be shown around the PopupView. Default value is false.

Declaration

public bool ShowOverlayAlways { get; set; }

Property Value

Type	Description
System.Boolean

StaysOpen

Gets or sets a value indicating whether the PopupView should stay open, when the interaction is made outside its boundary area.

Declaration

public bool StaysOpen { get; set; }

Property Value

Type	Description
System.Boolean	The value indicating whether the PopupView should stay open, when the interaction is made outside its boundary area.

Methods

AwakeFromNib()

Called after the object has been loaded from the nib file.

Declaration

public override void AwakeFromNib()

Dismiss()

Dismisses the pop-up from the view.

Declaration

public void Dismiss()

Dispose()

Perform final clean up before it is released from memory.

Declaration

public void Dispose()

Dispose(Boolean)

Disposes the objects in the SfPopupLayout.

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing	Value indicating whether to dispose the objects or not.

LayoutSubviews()

Layouts the sub views.

Declaration

public override void LayoutSubviews()

PointInside(CGPoint, UIEvent)

Points the inside.

Declaration

public override bool PointInside(CGPoint point, UIEvent uievent)

Parameters

Type	Name	Description
CoreGraphics.CGPoint	point	The CoreGraphics.CGPoint.
UIKit.UIEvent	uievent	The UIKit.UIEvent.

Returns

Type	Description
System.Boolean	true, if inside was pointed, false otherwise.

Show()

Displays the Popup in the view.

Declaration

public void Show()

Show(nfloat, nfloat)

Displays the popup at the given x and y point.

Declaration

public void Show(nfloat xPosition, nfloat yPosition)

Parameters

Type	Name	Description
System.nfloat	xPosition	The x-point at which the popup should be displayed.
System.nfloat	yPosition	The y-point at which the popup should be displayed.

Show(nfloat, nfloat, UIView)

Displays the popup at the given x and y point.

Declaration

public void Show(nfloat xPosition, nfloat yPosition, UIView rootView = null)

Parameters

Type	Name	Description
System.nfloat	xPosition	The x-point at which the popup should be displayed.
System.nfloat	yPosition	The y-point at which the popup should be displayed.
UIKit.UIView	rootView	The root view of the Activity, if the root view is not SfPopupLayout.

Show(UIView)

Displays the Popup in the view.

Declaration

public void Show(UIView rootView = null)

Parameters

Type	Name	Description
UIKit.UIView	rootView	The root view of the Activity, if the root view is not SfPopupLayout.

ShowAtTouchPoint()

Displays the Popup at the touch point.

Declaration

public void ShowAtTouchPoint()

ShowRelativeToView(UIView, RelativePosition, Double, Double)

Displays popup, relative to the given view.

Declaration

public void ShowRelativeToView(UIView relativeView, RelativePosition relativePosition, double absoluteX = NaN, double absoluteY = NaN)

Parameters

Type	Name	Description
UIKit.UIView	relativeView	The view relative to which popup should be displayed.
RelativePosition	relativePosition	The position, where popup should be displayed, relative to the given view.
System.Double	absoluteX	Absolute X Point where the popup should be positioned from the relative view
System.Double	absoluteY	Absolute X Point where the popup should be positioned from the relative view

ShowRelativeToView(UIView, RelativePosition, UIView)

Displays popup, relative to the given view.

Declaration

public void ShowRelativeToView(UIView relativeView, RelativePosition relativePosition, UIView rootView = null)

Parameters

Type	Name	Description
UIKit.UIView	relativeView	The view relative to which popup should be displayed.
RelativePosition	relativePosition	The position, where popup should be displayed, The root view of the Activity, if the root view is not SfPopupLayout. relative to the given view.
UIKit.UIView	rootView

WillMoveToWindow(UIWindow)

Wills the move to window.

Declaration

public override void WillMoveToWindow(UIWindow window)

Parameters

Type	Name	Description
UIKit.UIWindow	window	The Window.

Events

Closed

This event will be fired whenever the PopupView is dismissed from the view.

Declaration

public event EventHandler Closed

Event Type

Type	Description
System.EventHandler

Remarks

This event fires whenever the IsOpen property is set as false.

Closing

This event will be fired whenever the PopupView is closing in the view. Occurring of this event can be cancelled based on conditions.

Declaration

public event EventHandler<CancelEventArgs> Closing

Event Type

Type	Description
System.EventHandler<System.ComponentModel.CancelEventArgs>

Opened

This event will be fired whenever the PopupView is shown in the view.

Declaration

public event EventHandler Opened

Event Type

Type	Description
System.EventHandler

Remarks

This event fires whenever the IsOpen property is set as true.

Opening

This event will be fired whenever the PopupView is opening in the view. Occurring of this event can be cancelled based on conditions.

Declaration

public event EventHandler<CancelEventArgs> Opening

Event Type

Type	Description
System.EventHandler<System.ComponentModel.CancelEventArgs>