Class SfPullToRefresh

Represents a panel that a refreshing content and Refreshes the main content of the application.

Inheritance

System.Object

SfPullToRefresh

Namespace: Syncfusion.UI.Xaml.PullToRefresh

Assembly: Syncfusion.SfPullToRefresh.UWP.dll

Syntax

[ClassReference(IsReviewed = false)]
public class SfPullToRefresh : Control

Remarks

PullToRefresh is a Syncfusion.UI.Xaml.PullToRefresh panel which can swiped down on the appliation to refresh the contents of the page It is hidden most of the time, but is revealed when the user swipes a finger down on the screen

Constructors

SfPullToRefresh()

Declaration

public SfPullToRefresh()

Fields

PositionProperty

Declaration

public static readonly DependencyProperty PositionProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

ProgressBackgroundProperty

Using a DependencyProperty as the backing store for ProgressBackground. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty ProgressBackgroundProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

ProgressControlProperty

Declaration

public static readonly DependencyProperty ProgressControlProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

ProgressProperty

Using a DependencyProperty as the backing store for Progress. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty ProgressProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

ProgressRadiusProperty

Using a DependencyProperty as the backing store for Radius. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty ProgressRadiusProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

ProgressStrokeColorProperty

Using a DependencyProperty as the backing store for SegmentColor. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty ProgressStrokeColorProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

ProgressStrokeThicknessProperty

Declaration

public static readonly DependencyProperty ProgressStrokeThicknessProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

PullableContentProperty

Using a DependencyProperty as the backing store for PullableContent. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty PullableContentProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

PullingThresholdProperty

Using a DependencyProperty as the backing store for PullingThreshold. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty PullingThresholdProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

RefreshContentHeightProperty

Using a DependencyProperty as the backing store for RefreshContentHeight. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty RefreshContentHeightProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

RefreshContentProperty

Using a DependencyProperty as the backing store for RefreshContent. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty RefreshContentProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

RefreshContentWidthProperty

Declaration

public static readonly DependencyProperty RefreshContentWidthProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

RefreshTextProperty

Using a DependencyProperty as the backing store for RefreshText. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty RefreshTextProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

TransitionProperty

Using a DependencyProperty as the backing store for Transition. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty TransitionProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

Properties

isRefreshing

Declaration

public bool isRefreshing { get; }

Property Value

Type
System.Boolean

Position

Declaration

public Position Position { get; set; }

Property Value

Type
Position

Progress

Gets or sets the ProgressControl Progress value

Declaration

[ClassReference(IsReviewed = false)]
public double Progress { get; set; }

Property Value

Type	Description
System.Double	Default value is 0d

ProgressBackground

Gets or sets the ProgressControl BackgroundSfPullToRefresh.

Declaration

[ClassReference(IsReviewed = false)]
public Brush ProgressBackground { get; set; }

Property Value

Type	Description
Windows.UI.Xaml.Media.Brush	Default value is Transparent

Remarks

Works only if RefreshContent is null

See Also

SfPullToRefresh

ProgressRadius

Gets or sets the ProgressControl radiusSfPullToRefresh.

Declaration

[ClassReference(IsReviewed = false)]
public int ProgressRadius { get; set; }

Property Value

Type	Description
System.Int32	Default value is 0d

Remarks

Works only if RefreshContent is null

See Also

SfPullToRefresh

ProgressStrokeColor

Gets or sets the ProgressControl Stroke ColorSfPullToRefresh.

Declaration

[ClassReference(IsReviewed = false)]
public Brush ProgressStrokeColor { get; set; }

Property Value

Type	Description
Windows.UI.Xaml.Media.Brush	Default value is White

Remarks

Works only if RefreshContent is null

See Also

SfPullToRefresh

ProgressStrokeThickness

Gets or sets the ProgressControl ThicknessSfPullToRefresh.

Declaration

[ClassReference(IsReviewed = false)]
public int ProgressStrokeThickness { get; set; }

Property Value

Type	Description
System.Int32	Default value is 2d

Remarks

Works only if RefreshContent is null

See Also

SfPullToRefresh

PullableContent

Gets or sets the PullableContentSfPullToRefresh.

Declaration

[ClassReference(IsReviewed = false)]
public object PullableContent { get; set; }

Property Value

Type	Description
System.Object	Default value is null

See Also

SfPullToRefresh

PullingThreshold

Gets or sets the pulling threshold till which the refresh content can be pulledSfPullToRefresh.

Declaration

[ClassReference(IsReviewed = false)]
public double PullingThreshold { get; set; }

Property Value

Type	Description
System.Double	Default value is 0d

See Also

SfPullToRefresh

RefreshCommand

Declaration

public ICommand RefreshCommand { get; }

Property Value

Type
System.Windows.Input.ICommand

RefreshContent

Gets or sets the RefreshContentSfPullToRefresh.

Declaration

[ClassReference(IsReviewed = false)]
public object RefreshContent { get; set; }

Property Value

Type	Description
System.Object	Default value is null

See Also

SfPullToRefresh

RefreshContentHeight

Gets or sets the RefreshContentHeightSfPullToRefresh.

Declaration

[ClassReference(IsReviewed = false)]
public double RefreshContentHeight { get; set; }

Property Value

Type	Description
System.Double	Default value is 75d

See Also

SfPullToRefresh

RefreshContentWidth

Gets or sets the RefreshContentWidthSfPullToRefresh.

Declaration

[ClassReference(IsReviewed = false)]
public double RefreshContentWidth { get; set; }

Property Value

Type	Description
System.Double	Default value is 0d

See Also

SfPullToRefresh

RefreshText

Gets or sets the RefreshText for the RefreshContentSfPullToRefresh.

Declaration

[ClassReference(IsReviewed = false)]
public string RefreshText { get; set; }

Property Value

Type	Description
System.String	Default value is ""

See Also

SfPullToRefresh

Transition

Gets or sets the Transition for the SfPullToRefresh controlSfPullToRefresh.

Declaration

[ClassReference(IsReviewed = false)]
public Transition Transition { get; set; }

Property Value

Type	Description
Transition	Default value is SlideOnTop

See Also

SfPullToRefresh

Methods

add_Pulling(PullingEventHandler)

Declaration

public void add_Pulling(PullingEventHandler value)

Parameters

Type	Name	Description
PullingEventHandler	value

add_Refreshed(RefreshEventHandler)

Declaration

public void add_Refreshed(RefreshEventHandler value)

Parameters

Type	Name	Description
RefreshEventHandler	value

add_Refreshing(RefreshEventHandler)

Declaration

public void add_Refreshing(RefreshEventHandler value)

Parameters

Type	Name	Description
RefreshEventHandler	value

EndRefreshing()

Declaration

public void EndRefreshing()

OnApplyTemplate()

Declaration

protected override void OnApplyTemplate()

OnManipulationCompleted(ManipulationCompletedRoutedEventArgs)

Declaration

protected override void OnManipulationCompleted(ManipulationCompletedRoutedEventArgs e)

Parameters

Type	Name	Description
Windows.UI.Xaml.Input.ManipulationCompletedRoutedEventArgs	e

OnManipulationDelta(ManipulationDeltaRoutedEventArgs)

Declaration

protected override void OnManipulationDelta(ManipulationDeltaRoutedEventArgs e)

Parameters

Type	Name	Description
Windows.UI.Xaml.Input.ManipulationDeltaRoutedEventArgs	e

OnManipulationStarted(ManipulationStartedRoutedEventArgs)

Declaration

protected override void OnManipulationStarted(ManipulationStartedRoutedEventArgs e)

Parameters

Type	Name	Description
Windows.UI.Xaml.Input.ManipulationStartedRoutedEventArgs	e

remove_Pulling(PullingEventHandler)

Declaration

public void remove_Pulling(PullingEventHandler value)

Parameters

Type	Name	Description
PullingEventHandler	value

remove_Refreshed(RefreshEventHandler)

Declaration

public void remove_Refreshed(RefreshEventHandler value)

Parameters

Type	Name	Description
RefreshEventHandler	value

remove_Refreshing(RefreshEventHandler)

Declaration

public void remove_Refreshing(RefreshEventHandler value)

Parameters

Type	Name	Description
RefreshEventHandler	value

StartRefreshing()

Declaration

public void StartRefreshing()

Events

Pulling

Event for Pulling

Declaration

[ClassReference(IsReviewed = false)]
public event PullingEventHandler Pulling

Event Type

Type	Description
PullingEventHandler	Arguments - SfPullToRefresh, Progress

Refreshed

Event for Refreshed

Declaration

[ClassReference(IsReviewed = false)]
public event RefreshEventHandler Refreshed

Event Type

Type	Description
RefreshEventHandler	Arguments - SfPullToRefresh

Refreshing

Event for Refreshing

Declaration

[ClassReference(IsReviewed = false)]
public event RefreshEventHandler Refreshing

Event Type

Type	Description
RefreshEventHandler	Arguments - SfPullToRefresh

Extension Methods

DateTimeExtension.ToDateTime(Object)