Interface ICarousel

ICarousel Interface

Namespace: Syncfusion.Maui.Core.Carousel

Assembly: Syncfusion.Maui.Core.dll

Syntax

public interface ICarousel : IView, IElement, ITransform

Properties

AllowLoadMore

Gets or sets a value indicating whether this ICarousel allow load more.

Declaration

bool AllowLoadMore { get; set; }

Property Value

Type
System.Boolean

Duration

Gets or sets the value of Duration. This property can be used to give delay on selection animation.

Declaration

int Duration { get; set; }

Property Value

Type
System.Int32

EnableInteraction

Gets or sets a value indicating whether the it's allow interaction.

Declaration

bool EnableInteraction { get; set; }

Property Value

Type
System.Boolean

EnableVirtualization

Gets or sets a value indicating whether enable virtualization or not.

Declaration

bool EnableVirtualization { get; set; }

Property Value

Type
System.Boolean

ItemHeight

Gets or sets the value of the ItemHeight. This property can be used to customize the height of each carousel item.

Declaration

int ItemHeight { get; set; }

Property Value

Type
System.Int32

ItemSpacing

Gets or sets the value of the ItemSpacing. This property can be used to apply space between each item. Apply only in linear view mode.

Declaration

int ItemSpacing { get; set; }

Property Value

Type
System.Int32

ItemsSource

Gets or sets a collection of type carousel items that can be rendered with different view for each item.

Declaration

IEnumerable<object> ItemsSource { get; set; }

Property Value

Type
System.Collections.Generic.IEnumerable<System.Object>

ItemTemplate

Gets or sets an instance of the Template class that defines the visual structure of a Carousel item.

Declaration

DataTemplate ItemTemplate { get; set; }

Property Value

Type
Microsoft.Maui.Controls.DataTemplate

ItemWidth

Gets or sets the value of ItemWidth. This property can be used to customize the width of each carousel item.

Declaration

int ItemWidth { get; set; }

Property Value

Type
System.Int32

LoadMoreItemsCount

Gets or sets the value of LoadMoreItemsCount. By using the LoadMoreItemsCount property, numerous items can be separated.

Declaration

int LoadMoreItemsCount { get; set; }

Property Value

Type
System.Int32

LoadMoreView

Gets or sets the value of the LoadMoreView. By using this property, custom view can be passed instead of the LoadMore label.

Declaration

View LoadMoreView { get; set; }

Property Value

Type
Microsoft.Maui.Controls.View

Offset

Gets or sets the value of Offset. This property can be used to give the space between each item in the Default view mode.

Declaration

float Offset { get; set; }

Property Value

Type
System.Single

RotationAngle

Gets or sets the value of RotationAngle. It is an angle that tilts the unselected items. Apply only in the Default view mode.

Declaration

int RotationAngle { get; set; }

Property Value

Type
System.Int32

ScaleOffset

Gets or sets the value of Offset. It is a scaling ratio to differentiate unselected items in the Default view mode.

Declaration

float ScaleOffset { get; set; }

Property Value

Type
System.Single

SelectedIndex

Gets or sets the item to be in a selected state and to be the center item of the control among the user input.

Declaration

int SelectedIndex { get; set; }

Property Value

Type
System.Int32

SelectedItemOffset

Gets or sets the value of SelectedItemOffset. It gives space between the selected and unselected items in the Default view mode.

Declaration

int SelectedItemOffset { get; set; }

Property Value

Type
System.Int32

SwipeMovementMode

Gets or sets a value of scroll mode.

Declaration

SwipeMovementMode SwipeMovementMode { get; set; }

Property Value

Type
SwipeMovementMode

ViewMode

Gets or sets the mode used to arrange the items as default 3D view or in a horizontal stacked layout.

Declaration

ViewMode ViewMode { get; set; }

Property Value

Type
ViewMode

Methods

LoadMore()

Load more items in the carousal.

Declaration

virtual void LoadMore()

MoveNext()

Moves to the next item in the carousel.

Declaration

virtual void MoveNext()

MovePrevious()

Moves to the previous item in the carousal.

Declaration

virtual void MovePrevious()

RaiseSelectionChanged(SelectionChangedEventArgs)

Invokes the selection changed event

Declaration

virtual void RaiseSelectionChanged(SelectionChangedEventArgs args)

Parameters

Type	Name	Description
SelectionChangedEventArgs	args

RaiseSwipeEnded(EventArgs)

Invokes the swipe ended event

Declaration

virtual void RaiseSwipeEnded(EventArgs args)

Parameters

Type	Name	Description
System.EventArgs	args

RaiseSwipeStarted(SwipeStartedEventArgs)

Invokes the swipe started event

Declaration

virtual void RaiseSwipeStarted(SwipeStartedEventArgs args)

Parameters

Type	Name	Description
SwipeStartedEventArgs	args