Class SfPullToRefresh

A refresh control that allows you to interact and refresh the view loaded in it. The SfPullToRefresh control allows you to refresh the view upon performing the pull to refresh action.

Inheritance

System.Object

SfPullToRefresh

Namespace: Syncfusion.SfPullToRefresh

Assembly: Syncfusion.SfPullToRefresh.iOS.dll

Syntax

public class SfPullToRefresh : UIView

Constructors

SfPullToRefresh()

Initializes a new instance of SfPullToRefresh class.

Declaration

public SfPullToRefresh()

SfPullToRefresh(CGRect)

Initializes a new instance of SfPullToRefresh class.

Declaration

public SfPullToRefresh(CGRect rect)

Parameters

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

SfPullToRefresh(IntPtr)

Initializes a new instance of SfPullToRefresh class.

Declaration

public SfPullToRefresh(IntPtr ptr)

Parameters

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

Properties

IsRefreshing

Gets a value indicating whether to enable or disable the refreshing or not.

Declaration

public bool IsRefreshing { get; }

Property Value

Type	Description
System.Boolean	A value indicating whether to enable or disable the refreshing or not.

Progress

Gets the percentage of the progress of pulling.

Declaration

public float Progress { get; }

Property Value

Type	Description
System.Single	The percentage of the progress of pulling.

ProgressBackgroundColor

Gets or sets the progress background color of the SfPullToRefresh.

Declaration

public UIColor ProgressBackgroundColor { get; set; }

Property Value

Type	Description
UIKit.UIColor	The progress background color of the SfPullToRefresh.

ProgressShadowColor

Gets or sets the shadow color of the progress view.

Declaration

public UIColor ProgressShadowColor { get; set; }

Property Value

Type	Description
UIKit.UIColor	The shadow color of the progress view.

ProgressStrokeColor

Gets or sets the progress stroke color of the SfPullToRefresh.

Declaration

public UIColor ProgressStrokeColor { get; set; }

Property Value

Type	Description
UIKit.UIColor	The progress stroke color of the SfPullToRefresh.

ProgressStrokeWidth

Gets or sets the progress indicator stroke width.

Declaration

public double ProgressStrokeWidth { get; set; }

Property Value

Type	Description
System.Double	The progress indicator stroke width.

PullableContent

Gets or sets the pullable content of the SfPullToRefresh.

Declaration

public UIView PullableContent { get; set; }

Property Value

Type	Description
UIKit.UIView	The pullable content of the SfPullToRefresh.

PullingThreshold

Gets or sets the value for the pulling threshold, this indicate progress indicator maximum pulling position in view.

Declaration

public int PullingThreshold { get; set; }

Property Value

Type	Description
System.Int32	The value for the pulling threshold, this indicate progress indicator maximum pulling position in view.

RefreshContentRadius

Gets or sets the radius of the refreshing view.

Declaration

public int RefreshContentRadius { get; set; }

Property Value

Type	Description
System.Int32	The radius of the refreshing view.

RefreshContentThreshold

Gets or sets the refresh content threshold value that indicates progress indicator starting position in view.

Declaration

public int RefreshContentThreshold { get; set; }

Property Value

Type	Description
System.Int32	The refresh content threshold value that indicates progress indicator starting position in view.

TransitionType

Gets or sets the transition mode of the SfPullToRefresh.

Declaration

public TransitionType TransitionType { get; set; }

Property Value

Type	Description
TransitionType	The transition mode of the SfPullToRefresh.

Methods

add_Pulling(PullingEventHandler)

Declaration

public void add_Pulling(PullingEventHandler value)

Parameters

Type	Name	Description
PullingEventHandler	value

add_Refreshed(RefreshedEventHandler)

Declaration

public void add_Refreshed(RefreshedEventHandler value)

Parameters

Type	Name	Description
RefreshedEventHandler	value

add_Refreshing(RefreshingEventHandler)

Declaration

public void add_Refreshing(RefreshingEventHandler value)

Parameters

Type	Name	Description
RefreshingEventHandler	value

AwakeFromNib()

Awakes from nib.

Declaration

public override void AwakeFromNib()

Dispose(Boolean)

Releases the unmanaged resources used by the component and optionally releases the managed resources.

Declaration

protected override void Dispose(bool isDisposing)

Parameters

Type	Name	Description
System.Boolean	isDisposing	if true - release both managed and unmanaged resources; if false - release only unmanaged resources.

EndRefreshing()

Ends refreshing the pullable content stopping the refreshing animation.

Declaration

public void EndRefreshing()

LayoutSubviews()

Layouts the children in the view.

Declaration

public override void LayoutSubviews()

PointInside(CGPoint, UIEvent)

Returns a Boolean value indicating whether the receiver contains the specified point.

Declaration

public override bool PointInside(CGPoint point, UIEvent uievent)

Parameters

Type	Name	Description
CoreGraphics.CGPoint	point	A point that is in the receiver’s local coordinate system (bounds).
UIKit.UIEvent	uievent	The UIKit.UIEvent.

Returns

Type	Description
System.Boolean	YES if point is inside the receiver’s bounds; otherwise, NO.

remove_Pulling(PullingEventHandler)

Declaration

public void remove_Pulling(PullingEventHandler value)

Parameters

Type	Name	Description
PullingEventHandler	value

remove_Refreshed(RefreshedEventHandler)

Declaration

public void remove_Refreshed(RefreshedEventHandler value)

Parameters

Type	Name	Description
RefreshedEventHandler	value

remove_Refreshing(RefreshingEventHandler)

Declaration

public void remove_Refreshing(RefreshingEventHandler value)

Parameters

Type	Name	Description
RefreshingEventHandler	value

StartRefreshing()

Starts refreshing the pullable content displaying the refreshing animation.

Declaration

public void StartRefreshing()

WillMoveToWindow(UIWindow)

Move to window at runtime

Declaration

public override void WillMoveToWindow(UIWindow window)

Parameters

Type	Name	Description
UIKit.UIWindow	window	UIWindow.

Events

Pulling

Occurs when pulling operation is performed.

Declaration

public event PullingEventHandler Pulling

Event Type

Type	Description
PullingEventHandler

Refreshed

Occurs once refreshing is completed.

Declaration

public event RefreshedEventHandler Refreshed

Event Type

Type	Description
RefreshedEventHandler

Refreshing

Occurs when refreshing operation is started.

Declaration

public event RefreshingEventHandler Refreshing

Event Type

Type	Description
RefreshingEventHandler