Class CarouselBuilder

Inheritance

System.Object

ControlBuilder

CarouselBuilder

Inherited Members

ControlBuilder.Context

Namespace: Syncfusion.EJ2.Navigations

Assembly: Syncfusion.EJ2.dll

Syntax

public class CarouselBuilder : ControlBuilder

Constructors

CarouselBuilder()

Declaration

public CarouselBuilder()

CarouselBuilder(Carousel)

Declaration

public CarouselBuilder(Carousel model)

Parameters

Type	Name	Description
Carousel	model

Fields

model

Declaration

public Carousel model

Field Value

Type	Description
Carousel

Properties

HtmlAttr

Declaration

public IDictionary<string, object> HtmlAttr { get; set; }

Property Value

Type	Description
System.Collections.Generic.IDictionary<System.String, System.Object>

ID

Declaration

public string ID { get; set; }

Property Value

Type	Description
System.String

Output

Declaration

public override TextWriter Output { get; set; }

Property Value

Type	Description
System.IO.TextWriter

Overrides

ControlBuilder.Output

Methods

AnimationEffect(CarouselAnimationEffect)

Specifies the type of animation effects. The possible values for this property as follows None: The carousel item transition happens without animation. Slide: The carousel item transition happens with slide animation. Fade: The Carousel item transition happens with fade animation. Custom: The Carousel item transition happens with custom animation.

Declaration

public CarouselBuilder AnimationEffect(CarouselAnimationEffect animationEffect)

Parameters

Type	Name	Description
CarouselAnimationEffect	animationEffect

Returns

Type	Description
CarouselBuilder

AutoPlay(Boolean)

Defines whether the slide transition is automatic or manual.

Declaration

public CarouselBuilder AutoPlay(bool autoPlay = true)

Parameters

Type	Name	Description
System.Boolean	autoPlay

Returns

Type	Description
CarouselBuilder

ButtonsVisibility(CarouselButtonVisibility)

Defines how to show the previous, next and play pause buttons visibility. The possible values for this property as follows Hidden: Navigation buttons are hidden. Visible: Navigation buttons are visible. VisibleOnHover: Navigation buttons are visible only when we hover the carousel.

Declaration

public CarouselBuilder ButtonsVisibility(CarouselButtonVisibility buttonsVisibility)

Parameters

Type	Name	Description
CarouselButtonVisibility	buttonsVisibility

Returns

Type	Description
CarouselBuilder

CssClass(String)

Accepts single/multiple classes (separated by a space) to be used for carousel customization.

Declaration

public CarouselBuilder CssClass(string cssClass)

Parameters

Type	Name	Description
System.String	cssClass

Returns

Type	Description
CarouselBuilder

DataSource(Action<DataManagerBuilder>)

Declaration

public CarouselBuilder DataSource(Action<DataManagerBuilder> dataSource)

Parameters

Type	Name	Description
System.Action<DataManagerBuilder>	dataSource

Returns

Type	Description
CarouselBuilder

DataSource(Object)

Specifies the datasource for the carousel items.

Declaration

public CarouselBuilder DataSource(object dataSource)

Parameters

Type	Name	Description
System.Object	dataSource

Returns

Type	Description
CarouselBuilder

EnablePersistence(Boolean)

Enable or disable persisting component's state between page reloads.

Declaration

public CarouselBuilder EnablePersistence(bool enablePersistence = true)

Parameters

Type	Name	Description
System.Boolean	enablePersistence

Returns

Type	Description
CarouselBuilder

EnableRtl(Boolean)

Enable or disable rendering component in right to left direction.

Declaration

public CarouselBuilder EnableRtl(bool enableRtl = true)

Parameters

Type	Name	Description
System.Boolean	enableRtl

Returns

Type	Description
CarouselBuilder

EnableTouchSwipe(Boolean)

Defines whether to enable swipe action in touch devices or not.

Declaration

public CarouselBuilder EnableTouchSwipe(bool enableTouchSwipe = true)

Parameters

Type	Name	Description
System.Boolean	enableTouchSwipe

Returns

Type	Description
CarouselBuilder

Height(Double)

Specifies the height of the Carousel in pixels/number/percentage. The number value is considered as pixels.

Declaration

public CarouselBuilder Height(double height)

Parameters

Type	Name	Description
System.Double	height

Returns

Type	Description
CarouselBuilder

Height(String)

Specifies the height of the Carousel in pixels/number/percentage. The number value is considered as pixels.

Declaration

public CarouselBuilder Height(string height)

Parameters

Type	Name	Description
System.String	height

Returns

Type	Description
CarouselBuilder

HtmlAttributes(Object)

Accepts HTML attributes/custom attributes to add in individual carousel item.

Declaration

public CarouselBuilder HtmlAttributes(object htmlAttributes)

Parameters

Type	Name	Description
System.Object	htmlAttributes

Returns

Type	Description
CarouselBuilder

IndicatorsTemplate(String)

Accepts the template for indicator buttons.

Declaration

public CarouselBuilder IndicatorsTemplate(string indicatorsTemplate)

Parameters

Type	Name	Description
System.String	indicatorsTemplate

Returns

Type	Description
CarouselBuilder

IndicatorsType(CarouselIndicatorsType)

Specifies the type of indicators. The available values for this property are:

Declaration

public CarouselBuilder IndicatorsType(CarouselIndicatorsType indicatorsType)

Parameters

Type	Name	Description
CarouselIndicatorsType	indicatorsType

Returns

Type	Description
CarouselBuilder

Interval(Double)

Specifies the interval duration in milliseconds for carousel item transition.

Declaration

public CarouselBuilder Interval(double interval)

Parameters

Type	Name	Description
System.Double	interval

Returns

Type	Description
CarouselBuilder

Items(Action<CarouselItemBuilder>)

Declaration

public CarouselBuilder Items(Action<CarouselItemBuilder> items)

Parameters

Type	Name	Description
System.Action<CarouselItemBuilder>	items

Returns

Type	Description
CarouselBuilder

Items(List<CarouselItem>)

Allows defining the collection of carousel item to be displayed on the Carousel.

Declaration

public CarouselBuilder Items(List<CarouselItem> items)

Parameters

Type	Name	Description
System.Collections.Generic.List<CarouselItem>	items

Returns

Type	Description
CarouselBuilder

ItemTemplate(String)

Specifies the template option for carousel items.

Declaration

public CarouselBuilder ItemTemplate(string itemTemplate)

Parameters

Type	Name	Description
System.String	itemTemplate

Returns

Type	Description
CarouselBuilder

Locale(String)

Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

Declaration

public CarouselBuilder Locale(string locale)

Parameters

Type	Name	Description
System.String	locale

Returns

Type	Description
CarouselBuilder

Loop(Boolean)

Defines whether the slide transitions loop end or not. When set to false, the transition stops at last slide.

Declaration

public CarouselBuilder Loop(bool loop = true)

Parameters

Type	Name	Description
System.Boolean	loop

Returns

Type	Description
CarouselBuilder

NextButtonTemplate(String)

Accepts the template for next navigation button.

Declaration

public CarouselBuilder NextButtonTemplate(string nextButtonTemplate)

Parameters

Type	Name	Description
System.String	nextButtonTemplate

Returns

Type	Description
CarouselBuilder

PartialVisible(Boolean)

Enables active slide with partial previous/next slides.

Declaration

public CarouselBuilder PartialVisible(bool partialVisible = true)

Parameters

Type	Name	Description
System.Boolean	partialVisible

Returns

Type	Description
CarouselBuilder

PauseOnHover(Boolean)

Defines whether the slide transition gets pause on hover or not.

Declaration

public CarouselBuilder PauseOnHover(bool pauseOnHover = true)

Parameters

Type	Name	Description
System.Boolean	pauseOnHover

Returns

Type	Description
CarouselBuilder

PlayButtonTemplate(String)

Accepts the template for play/pause button.

Declaration

public CarouselBuilder PlayButtonTemplate(string playButtonTemplate)

Parameters

Type	Name	Description
System.String	playButtonTemplate

Returns

Type	Description
CarouselBuilder

PreviousButtonTemplate(String)

Accepts the template for previous navigation button.

Declaration

public CarouselBuilder PreviousButtonTemplate(string previousButtonTemplate)

Parameters

Type	Name	Description
System.String	previousButtonTemplate

Returns

Type	Description
CarouselBuilder

Render()

Declaration

public HtmlString Render()

Returns

Type	Description
Microsoft.AspNetCore.Html.HtmlString

SelectedIndex(Double)

Specifies index of the current carousel item.

Declaration

public CarouselBuilder SelectedIndex(double selectedIndex)

Parameters

Type	Name	Description
System.Double	selectedIndex

Returns

Type	Description
CarouselBuilder

ShowIndicators(Boolean)

Defines whether to show the indicator positions or not. The indicator positions allow to know the current slide position of the carousel component.

Declaration

public CarouselBuilder ShowIndicators(bool showIndicators = true)

Parameters

Type	Name	Description
System.Boolean	showIndicators

Returns

Type	Description
CarouselBuilder

ShowPlayButton(Boolean)

Defines whether to show play button or not.

Declaration

public CarouselBuilder ShowPlayButton(bool showPlayButton = true)

Parameters

Type	Name	Description
System.Boolean	showPlayButton

Returns

Type	Description
CarouselBuilder

SlideChanged(String)

The event will be fired after the slide changed.

Declaration

public CarouselBuilder SlideChanged(string slideChanged)

Parameters

Type	Name	Description
System.String	slideChanged

Returns

Type	Description
CarouselBuilder

SlideChanging(String)

The event will be fired before the slide change.

Declaration

public CarouselBuilder SlideChanging(string slideChanging)

Parameters

Type	Name	Description
System.String	slideChanging

Returns

Type	Description
CarouselBuilder

SwipeMode(CarouselSwipeMode)

Specifies whether the slide transition should occur while performing swiping via touch/mouse. The slide swiping is enabled or disabled using bitwise operators. The swiping is disabled using ‘~’ bitwise operator. Touch - Enables or disables the swiping action in touch interaction. Mouse - Enables or disables the swiping action in mouse interaction.

Declaration

public CarouselBuilder SwipeMode(CarouselSwipeMode swipeMode)

Parameters

Type	Name	Description
CarouselSwipeMode	swipeMode

Returns

Type	Description
CarouselBuilder

Width(Double)

Specifies the width of the Carousel in pixels/number/percentage. The number value is considered as pixels.

Declaration

public CarouselBuilder Width(double width)

Parameters

Type	Name	Description
System.Double	width

Returns

Type	Description
CarouselBuilder

Width(String)

Specifies the width of the Carousel in pixels/number/percentage. The number value is considered as pixels.

Declaration

public CarouselBuilder Width(string width)

Parameters

Type	Name	Description
System.String	width

Returns

Type	Description
CarouselBuilder