Class SfRotator

Represents a control that allows user to showcase a collection of items that can slide either vertically or horizontally.

Inheritance

System.Object

SfRotator

Implements

IParallaxView

Namespace: Syncfusion.SfRotator.XForms

Assembly: Syncfusion.SfRotator.XForms.dll

Syntax

public class SfRotator : View, IParallaxView, IParentThemeElement, IThemeElement

Constructors

SfRotator()

Initializes a new instance of the SfRotator class.

Declaration

public SfRotator()

Fields

CommandParameterProperty

Identifies the CommandParameter bindable property. It is a parameter to pass to the Command property. This is a bindable property.

Declaration

public static readonly BindableProperty CommandParameterProperty

Field Value

Type
Xamarin.Forms.BindableProperty

Remarks

This bindable property is read-only.

CommandProperty

Identifies the Command bindable property. It invokes when the button is activated. The default value is null.

Declaration

public static readonly BindableProperty CommandProperty

Field Value

Type
Xamarin.Forms.BindableProperty

Remarks

This bindable property is read-only.

DataSourceProperty

DataSource property is deprecated, please use ItemsSource property instead.

Declaration

public static readonly BindableProperty DataSourceProperty

Field Value

Type
Xamarin.Forms.BindableProperty

DotPlacementProperty

Identifies the DotPlacement bindable property. The value determines the placement of Dots representation.

Declaration

public static readonly BindableProperty DotPlacementProperty

Field Value

Type
Xamarin.Forms.BindableProperty

DotsBorderColorProperty

Identifies the DotsBorderColor bindable property. The border color of the Dots representation.

Declaration

public static readonly BindableProperty DotsBorderColorProperty

Field Value

Type
Xamarin.Forms.BindableProperty

EnableAutoPlayProperty

Identifies the EnableAutoPlay bindable property. The value that indicates whether to enable or disable auto sliding of the items.

Declaration

public static readonly BindableProperty EnableAutoPlayProperty

Field Value

Type
Xamarin.Forms.BindableProperty

EnableLoopingProperty

Identifies the EnableLooping bindable property. The value enables or disables the cyclic sliding behavior when selection reaches the last item.

Declaration

public static readonly BindableProperty EnableLoopingProperty

Field Value

Type
Xamarin.Forms.BindableProperty

EnableSwipingProperty

Identifies the EnableSwiping bindable property. The value that enables or disables swipe touch gesture.

Declaration

public static readonly BindableProperty EnableSwipingProperty

Field Value

Type
Xamarin.Forms.BindableProperty

IsTextVisibleProperty

Identifies the IsTextVisible bindable property. The value enables or disables the default text of all rotator items.

Declaration

public static readonly BindableProperty IsTextVisibleProperty

Field Value

Type
Xamarin.Forms.BindableProperty

ItemsSourceProperty

collection of items that can be populated as Rotator items and get rendered at run-time based on the Template provided.

Declaration

public static readonly BindableProperty ItemsSourceProperty

Field Value

Type
Xamarin.Forms.BindableProperty

ItemTemplateProperty

Identifies the ItemTemplate bindable property. The instance of the Template class defines visual structure of a rotator item.

Declaration

public static readonly BindableProperty ItemTemplateProperty

Field Value

Type
Xamarin.Forms.BindableProperty

NavigationDelayProperty

Identifies the NavigationDelay bindable property. The value that determines the sliding animation delay when the control in auto play mode.

Declaration

public static readonly BindableProperty NavigationDelayProperty

Field Value

Type
Xamarin.Forms.BindableProperty

NavigationDirectionProperty

Identifies the NavigationDirection bindable property. The mode is used to slide item either vertically or horizontally.

Declaration

public static readonly BindableProperty NavigationDirectionProperty

Field Value

Type
Xamarin.Forms.BindableProperty

NavigationStripModeProperty

Identifies the NavigationStripMode bindable property. The value determines representation for items either Thambnail or Dots.

Declaration

public static readonly BindableProperty NavigationStripModeProperty

Field Value

Type
Xamarin.Forms.BindableProperty

NavigationStripPositionProperty

Identifies the NavigationStripPosition bindable property. The value determines the placement of navigation strip.

Declaration

public static readonly BindableProperty NavigationStripPositionProperty

Field Value

Type
Xamarin.Forms.BindableProperty

SelectedDotColorProperty

Identifies the SelectedDotColor bindable property. The color to be filled for Selected Dot representation.

Declaration

public static readonly BindableProperty SelectedDotColorProperty

Field Value

Type
Xamarin.Forms.BindableProperty

SelectedIndexProperty

Identifies the SelectedIndex bindable property. This property can be used to change the index of selected item.

Declaration

public static readonly BindableProperty SelectedIndexProperty

Field Value

Type
Xamarin.Forms.BindableProperty

UnselectedDotColorProperty

Identifies the UnselectedDotColor bindable property. The color to be filled for UnSelected Dot representation.

Declaration

public static readonly BindableProperty UnselectedDotColorProperty

Field Value

Type
Xamarin.Forms.BindableProperty

Properties

Command

Gets or sets the value of the Command. It invokes when the button is activated. It is a bindale property.

Declaration

public ICommand Command { get; set; }

Property Value

Type	Description
System.Windows.Input.ICommand	The command.

CommandParameter

Gets or sets the value of the CommandParameter, which is a parameter to pass the Command property. This is a bindable property.

Declaration

public object CommandParameter { get; set; }

Property Value

Type	Description
System.Object	The command parameter.

DataSource

Gets or sets the DataSource property is deprecated, soe use the ItemsSource property instead.

Declaration

public List<SfRotatorItem> DataSource { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<SfRotatorItem>	The data source.

DotPlacement

Gets or sets a value that determines the placement of Dots representation in SfRotator.

Declaration

public DotPlacement DotPlacement { get; set; }

Property Value

Type
DotPlacement

DotsBorderColor

Gets or sets the value of DotsBorderColor. This property can be used to change the border color of Dots representation.

Declaration

public Color DotsBorderColor { get; set; }

Property Value

Type
Xamarin.Forms.Color

EnableAutoPlay

Gets or sets a value indicating whether gets or sets a Boolean value that indicates whether to enable or disable auto sliding of the items.

Declaration

public bool EnableAutoPlay { get; set; }

Property Value

Type	Description
System.Boolean	true if enable auto play; otherwise, false.

EnableLooping

Gets or sets a value indicating whether gets or sets a Boolean value that indicates whether to enable or disable the cyclic sliding behavior when selection reaches the last item.

Declaration

public bool EnableLooping { get; set; }

Property Value

Type	Description
System.Boolean	true if enable looping; otherwise, false.

EnableSwiping

Gets or sets a value indicating whether gets or sets a Boolean value that indicates whether to enable or disable swipe touch gesture in the SfRotator control.

Declaration

public bool EnableSwiping { get; set; }

Property Value

Type	Description
System.Boolean	true if enable auto play; otherwise, false.

IsTextVisible

Gets or sets a value indicating whether gets or sets a Boolean value that indicates whether to enable or disable the default text of all rotator items.

Declaration

public bool IsTextVisible { get; set; }

Property Value

Type	Description
System.Boolean	true if this instance is text visible; otherwise, false.

ItemsSource

Gets or sets a collection of items that can be populated as rotator items and rendered at run-time based on the Template provided.

Declaration

public IEnumerable<object> ItemsSource { get; set; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<System.Object>	The items source.

ItemTemplate

Gets or sets the value of ItemTemplate. It is an instance of the Template class that defines visual structure of a rotator item.

Declaration

public DataTemplate ItemTemplate { get; set; }

Property Value

Type	Description
Xamarin.Forms.DataTemplate	The item template.

NavigationDelay

Gets or sets the value that determines the sliding animation delay when the control in auto play mode.

Declaration

public int NavigationDelay { get; set; }

Property Value

Type	Description
System.Int32	The navigation delay.

NavigationDirection

Gets or sets the value of NavigationDirection. This mode is used to slide the item either vertically or horizontally.

Declaration

public NavigationDirection NavigationDirection { get; set; }

Property Value

Type	Description
NavigationDirection	The navigation direction.

NavigationStripMode

Gets or sets a value of NavigationStripMode. It determines representation for items either Thumbnail or Dots.

Declaration

public NavigationStripMode NavigationStripMode { get; set; }

Property Value

Type	Description
NavigationStripMode	The navigation strip mode.

NavigationStripPosition

Gets or sets a value of NavigationStripPosition that determines the placement of navigation strip.

Declaration

public NavigationStripPosition NavigationStripPosition { get; set; }

Property Value

Type	Description
NavigationStripPosition	The navigation strip position.

SelectedDotColor

Gets or sets the value of SelectedDotColor. It is a color to be filled for Selected Dot representation.

Declaration

public Color SelectedDotColor { get; set; }

Property Value

Type
Xamarin.Forms.Color

SelectedIndex

Gets or sets the value of SelectedIndex. This property can be used to change the index of selected item.

Declaration

public int SelectedIndex { get; set; }

Property Value

Type	Description
System.Int32	The index of the selected.

UnselectedDotColor

Gets or sets the value of UnselectedDotColor. It is a color to be filled for UnSelected Dot representation.

Declaration

public Color UnselectedDotColor { get; set; }

Property Value

Type
Xamarin.Forms.Color

Methods

add_SelectedIndexChanged(SfRotator.SelectedIndexChangedEventHandler)

Declaration

public void add_SelectedIndexChanged(SfRotator.SelectedIndexChangedEventHandler value)

Parameters

Type	Name	Description
SfRotator.SelectedIndexChangedEventHandler	value

OnSizeRequest(Double, Double)

Raises the size request event.

Declaration

protected override SizeRequest OnSizeRequest(double widthConstraint, double heightConstraint)

Parameters

Type	Name	Description
System.Double	widthConstraint	Width constraint.
System.Double	heightConstraint	Height constraint.

Returns

Type	Description
Xamarin.Forms.SizeRequest	return size.

Refresh()

Refresh thumbnail view.

Declaration

public void Refresh()

remove_SelectedIndexChanged(SfRotator.SelectedIndexChangedEventHandler)

Declaration

public void remove_SelectedIndexChanged(SfRotator.SelectedIndexChangedEventHandler value)

Parameters

Type	Name	Description
SfRotator.SelectedIndexChangedEventHandler	value

Events

ItemTapped

This event occurs when tab header item tapped in SfRotator

Declaration

public event EventHandler<EventArgs> ItemTapped

Event Type

Type
System.EventHandler<System.EventArgs>

SelectedIndexChanged

Occurs when users select an item from unselected items in SfRotator.

Declaration

public event SfRotator.SelectedIndexChangedEventHandler SelectedIndexChanged

Event Type

Type
SfRotator.SelectedIndexChangedEventHandler

Explicit Interface Implementations

IParallaxView.ScrollableContentSize

Gets or sets a value of total scrollable size of the rotator control.

Declaration

Size IParallaxView.ScrollableContentSize { get; set; }

Returns

Type
Xamarin.Forms.Size

IParallaxView.Scrolling

Occurs when the user scrolls the rotator item.

Declaration

event EventHandler<ParallaxScrollingEventArgs> IParallaxView.Scrolling

Returns

Type
System.EventHandler<ParallaxScrollingEventArgs>

Implements

IParallaxView