New to Telerik UI for .NET MAUI? Start a free 30-day trial

Represents a view that can be refreshed by a user interaction.

Definition

Namespace:Telerik.Maui.Controls

Assembly:Telerik.Maui.Controls.dll

Syntax:

C#
public class RadRefreshView : RadContentView, IRadContentView, IContentView, IView, IElement, ITransform, IPadding, ICrossPlatformLayout

Inheritance: objectRadContentViewRadRefreshView

Implements: IContentViewICrossPlatformLayoutIElementIPaddingIRadContentViewITransformIView...

Inherited Members RadContentView.ActualStyleClassPropertyRadContentView.OnChildAdded(Element)RadContentView.OnChildRemoved(Element, int)RadContentView.OnBindingContextChanged()RadContentView.OnHandlerChanged()

Constructors

Initializes a new instance of the RadRefreshView class.

C#
public RadRefreshView()

Fields

Identifies the ActualIndicatorStyle bindable property.

C#
public static readonly BindableProperty ActualIndicatorStyleProperty

CommandParameterProperty

BindableProperty

Identifies the CommandParameter bindable property.

C#
public static readonly BindableProperty CommandParameterProperty

CommandProperty

BindableProperty

Identifies the Command bindable property.

C#
public static readonly BindableProperty CommandProperty

ControlTemplateProperty

BindableProperty

Identifies the ControlTemplate bindable property.

C#
public static readonly BindableProperty ControlTemplateProperty

Identifies the IndicatorAreaLength bindable property.

C#
public static readonly BindableProperty IndicatorAreaLengthProperty

IndicatorStyleProperty

BindableProperty

Identifies the IndicatorStyle bindable property.

C#
public static readonly BindableProperty IndicatorStyleProperty

Identifies the IndicatorThreshold bindable property.

C#
public static readonly BindableProperty IndicatorThresholdProperty

IndicatorTypeProperty

BindableProperty

Identifies the IndicatorType bindable property.

C#
public static readonly BindableProperty IndicatorTypeProperty

IsRefreshEnabledProperty

BindableProperty

Identifies the IsRefreshEnabled bindable property.

C#
public static readonly BindableProperty IsRefreshEnabledProperty

IsRefreshingProperty

BindableProperty

Identifies the IsRefreshing bindable property.

C#
public static readonly BindableProperty IsRefreshingProperty

ProgressProperty

BindableProperty

Identifies the Progress bindable property.

C#
public static readonly BindableProperty ProgressProperty

PullDirectionProperty

BindableProperty

Identifies the PullDirection bindable property.

C#
public static readonly BindableProperty PullDirectionProperty

PullingTemplateProperty

BindableProperty

Identifies the PullingTemplate bindable property.

C#
public static readonly BindableProperty PullingTemplateProperty

PullingThresholdProperty

BindableProperty

Identifies the PullingThreshold bindable property.

C#
public static readonly BindableProperty PullingThresholdProperty

Identifies the RefreshingTemplate bindable property.

C#
public static readonly BindableProperty RefreshingTemplateProperty

TransitionModeProperty

BindableProperty

Identifies the TransitionMode bindable property.

C#
public static readonly BindableProperty TransitionModeProperty

Properties

Gets the merged custom and default styles applied to the refresh indicator.

C#
public Style ActualIndicatorStyle { get; }

Gets or sets the command invoked when a refresh starts, before the Refreshing event, if the command can execute. While the command cannot execute, pull gestures do not start a refresh. Setting IsRefreshing still starts one.

C#
public ICommand Command { get; set; }

Gets or sets the parameter passed to the refresh command.

C#
public object CommandParameter { get; set; }

ControlTemplate

ControlTemplate

Gets or sets the control template of this view.

C#
public ControlTemplate ControlTemplate { get; set; }

Gets or sets the length, in MAUI units, of the refresh indicator area along the pull direction.

C#
public double IndicatorAreaLength { get; set; }

Gets or sets the style applied to the built-in indicator selected by IndicatorType. The style target must be a type compatible with that indicator, otherwise the style is ignored and a warning is traced. This property does not select the indicator type.

C#
public Style IndicatorStyle { get; set; }

Gets or sets the pull distance, in MAUI units, at which the indicator begins to appear. If the value is not less than PullingThreshold, the indicator appears just before the pulling threshold is reached.

C#
public double IndicatorThreshold { get; set; }

Gets or sets the built-in indicator used while pulling and refreshing. The default is Circular on Android, Arrow on Windows, and Spinner on other platforms. PullingTemplate and RefreshingTemplate override the built-in indicator for their respective phases.

C#
public RefreshViewIndicatorType IndicatorType { get; set; }

Gets or sets whether pull gestures can initiate a refresh.

C#
public bool IsRefreshEnabled { get; set; }

Gets or sets whether a refresh is in progress.

C#
public bool IsRefreshing { get; set; }

Gets the normalized pull progress from 0.0 to 1.0. The value is 1.0 while refreshing.

C#
public double Progress { get; }

Gets or sets the physical direction of the pull gesture and the edge at which the indicator appears. The default is TopToBottom on all platforms. Horizontal directions are not reversed by . Changing the direction cancels an active pull and relocates an ongoing refresh without starting another refresh.

C#
public RefreshViewPullDirection PullDirection { get; set; }

PullingTemplate

DataTemplate

Gets or sets the content shown while the user is pulling. If this property is null, the built-in indicator selected by IndicatorType is used. If the template root does not have an explicitly set binding context, its binding context is set to this RadRefreshView.

C#
public DataTemplate PullingTemplate { get; set; }

Gets or sets the pull distance, in MAUI units, required to start a refresh when the user releases the gesture.

C#
public double PullingThreshold { get; set; }

RefreshingTemplate

DataTemplate

Gets or sets the content shown while a refresh is in progress. If this property is null, the built-in indicator selected by IndicatorType is used. If the template root does not have an explicitly set binding context, its binding context is set to this RadRefreshView.

C#
public DataTemplate RefreshingTemplate { get; set; }

Gets or sets how the indicator transitions relative to the content. The default is Reveal on iOS and MacCatalyst, Push on Windows, and Slide on Android.

C#
public RefreshViewTransitionMode TransitionMode { get; set; }

Methods

C#
protected override void OnApplyTemplate()
C#
protected override void OnHandlerChanging(HandlerChangingEventArgs args)
Parameters:argsHandlerChangingEventArgs
C#
protected override void OnPropertyChanged(string propertyName = null)
Parameters:propertyNamestring

Events

Occurs while the user pulls the content and before a refresh starts.

C#
public event EventHandler<RefreshViewPullingEventArgs> Pulling

Occurs when a refresh completes.

C#
public event EventHandler Refreshed

Occurs when a refresh starts, including refreshes started by setting IsRefreshing.

C#
public event EventHandler Refreshing