Class IgbCarousel

The igc-carousel presents a set of igc-carousel-slides by sequentially displaying a subset of one or more slides.

Inheritance
System.Object
BaseRendererControl
IgbCarousel
Implements
System.IDisposable
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbCarousel : BaseRendererControl, RefSink, JsonSerializable, IDisposable

Constructors

IgbCarousel()

Declaration
public IgbCarousel()

Properties

AnimationType

The animation type.

Declaration
public HorizontalTransitionAnimation AnimationType { get; set; }
Property Value
Type Description
HorizontalTransitionAnimation

DefaultEventBehavior

Declaration
protected override ControlEventBehavior DefaultEventBehavior { get; }
Property Value
Type Description
ControlEventBehavior
Overrides

DirectRenderElementName

Declaration
protected override string DirectRenderElementName { get; }
Property Value
Type Description
System.String
Overrides

DisableLoop

Whether the carousel should skip rotating to the first slide after it reaches the last.

Declaration
public bool DisableLoop { get; set; }
Property Value
Type Description
System.Boolean

DisablePauseOnInteraction

Whether the carousel should ignore use interactions and not pause on them.

Declaration
public bool DisablePauseOnInteraction { get; set; }
Property Value
Type Description
System.Boolean

HideIndicators

Whether the carousel should render the indicator controls (dots).

Declaration
public bool HideIndicators { get; set; }
Property Value
Type Description
System.Boolean

HideNavigation

Whether the carousel should skip rendering of the default navigation buttons.

Declaration
public bool HideNavigation { get; set; }
Property Value
Type Description
System.Boolean

IndicatorsLabelFormat

The format used to set the aria-label on the carousel indicators. Instances of '{0}' will be replaced with the index of the corresponding slide.

Declaration
public string IndicatorsLabelFormat { get; set; }
Property Value
Type Description
System.String

IndicatorsOrientation

Sets the orientation of the indicator controls (dots).

Declaration
public CarouselIndicatorsOrientation IndicatorsOrientation { get; set; }
Property Value
Type Description
CarouselIndicatorsOrientation

Interval

The duration in milliseconds between changing the active slide.

Declaration
public double Interval { get; set; }
Property Value
Type Description
System.Double

MaximumIndicatorsCount

Controls the maximum indicator controls (dots) that can be shown. Default value is 10.

Declaration
public double MaximumIndicatorsCount { get; set; }
Property Value
Type Description
System.Double

Paused

Declaration
public EventCallback<IgbVoidEventArgs> Paused { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbVoidEventArgs>

PausedScript

Declaration
public string PausedScript { get; set; }
Property Value
Type Description
System.String

Playing

Declaration
public EventCallback<IgbVoidEventArgs> Playing { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbVoidEventArgs>

PlayingScript

Declaration
public string PlayingScript { get; set; }
Property Value
Type Description
System.String

SlideChanged

Declaration
public EventCallback<IgbNumberEventArgs> SlideChanged { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbNumberEventArgs>

SlideChangedScript

Declaration
public string SlideChangedScript { get; set; }
Property Value
Type Description
System.String

SlidesLabelFormat

The format used to set the aria-label on the carousel slides and the text displayed when the number of indicators is greater than tha maximum indicator count. Instances of '{0}' will be replaced with the index of the corresponding slide. Instances of '{1}' will be replaced with the total amount of slides.

Declaration
public string SlidesLabelFormat { get; set; }
Property Value
Type Description
System.String

SupportsVisualChildren

Declaration
protected override bool SupportsVisualChildren { get; }
Property Value
Type Description
System.Boolean
Overrides

Type

Declaration
public override string Type { get; }
Property Value
Type Description
System.String
Overrides

UseDirectRender

Declaration
protected override bool UseDirectRender { get; }
Property Value
Type Description
System.Boolean
Overrides

Vertical

Whether the carousel has vertical alignment.

Declaration
public bool Vertical { get; set; }
Property Value
Type Description
System.Boolean

Methods

EnsureModulesLoaded()

Declaration
protected override void EnsureModulesLoaded()
Overrides

FindByName(String)

Declaration
public override object FindByName(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Object
Overrides

GetCurrent()

Declaration
public double GetCurrent()
Returns
Type Description
System.Double

GetCurrentAsync()

Declaration
public Task<double> GetCurrentAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Double>

GetIsPaused()

Declaration
public bool GetIsPaused()
Returns
Type Description
System.Boolean

GetIsPausedAsync()

Declaration
public Task<bool> GetIsPausedAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

GetIsPlaying()

Declaration
public bool GetIsPlaying()
Returns
Type Description
System.Boolean

GetIsPlayingAsync()

Declaration
public Task<bool> GetIsPlayingAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

GetTotal()

Declaration
public double GetTotal()
Returns
Type Description
System.Double

GetTotalAsync()

Declaration
public Task<double> GetTotalAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Double>

Next()

Declaration
public bool Next()
Returns
Type Description
System.Boolean

NextAsync()

Switches to the next slide, runs any animations, and returns if the operation was successful.

Declaration
public Task<bool> NextAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

Pause()

Declaration
public void Pause()

PauseAsync()

Pauses the carousel rotation of slides.

Declaration
public Task PauseAsync()
Returns
Type Description
System.Threading.Tasks.Task

Play()

Declaration
public void Play()

PlayAsync()

Resumes playing of the carousel slides.

Declaration
public Task PlayAsync()
Returns
Type Description
System.Threading.Tasks.Task

Prev()

Declaration
public bool Prev()
Returns
Type Description
System.Boolean

PrevAsync()

Switches to the previous slide, runs any animations, and returns if the operation was successful.

Declaration
public Task<bool> PrevAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

ResolveDisplay()

Declaration
protected override string ResolveDisplay()
Returns
Type Description
System.String
Overrides

Select(Double, Nullable<CarouselAnimationDirection>)

Declaration
public bool Select(double index, Nullable<CarouselAnimationDirection> animationDirection = null)
Parameters
Type Name Description
System.Double index
System.Nullable<CarouselAnimationDirection> animationDirection
Returns
Type Description
System.Boolean

SelectAsync(Double, Nullable<CarouselAnimationDirection>)

Declaration
public Task<bool> SelectAsync(double index, Nullable<CarouselAnimationDirection> animationDirection = null)
Parameters
Type Name Description
System.Double index
System.Nullable<CarouselAnimationDirection> animationDirection
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

SetNativeElement(Object)

Declaration
public void SetNativeElement(object element)
Parameters
Type Name Description
System.Object element

SetNativeElementAsync(Object)

Declaration
public Task SetNativeElementAsync(object element)
Parameters
Type Name Description
System.Object element
Returns
Type Description
System.Threading.Tasks.Task

Implements

System.IDisposable