Class RotatorPropertiesBuilder

Represents a class for RotatorPropertiesBuilder which includes enable auto play, show play button, show navigation button, and show thumbnail properties.

Inheritance

System.Object

RotatorPropertiesBuilder

Implements

IPropertiesBuilder

System.Web.IHtmlString

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Syncfusion.JavaScript

Assembly: Syncfusion.EJ.dll

Syntax

public class RotatorPropertiesBuilder : IPropertiesBuilder, IHtmlString

Constructors

RotatorPropertiesBuilder()

Declaration

public RotatorPropertiesBuilder()

RotatorPropertiesBuilder(Rotator)

Specifies rotator properties builder.

Declaration

public RotatorPropertiesBuilder(Rotator rotator)

Parameters

Type	Name	Description
Rotator	rotator

Fields

rotator

Declaration

public Rotator rotator

Field Value

Type	Description
Rotator

Properties

ItemsCollection

Declaration

public List<RotatorBaseItem> ItemsCollection { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<RotatorBaseItem>

Methods

AllowKeyboardNavigation()

Turns on keyboard interaction with the Rotator items. You must set this property to true to access the following keyboard shortcuts.

Declaration

public RotatorPropertiesBuilder AllowKeyboardNavigation()

Returns

Type	Description
RotatorPropertiesBuilder

AllowKeyboardNavigation(Boolean)

Turns on keyboard interaction with the Rotator items. You must set this property to true to access the following keyboard shortcuts.with boolean argument.

Declaration

public RotatorPropertiesBuilder AllowKeyboardNavigation(bool allowKeyboardNavigation)

Parameters

Type	Name	Description
System.Boolean	allowKeyboardNavigation

Returns

Type	Description
RotatorPropertiesBuilder

AnimationSpeed(Int32)

Sets the animationSpeed of slide transition.

Declaration

public RotatorPropertiesBuilder AnimationSpeed(int animationSpeed)

Parameters

Type	Name	Description
System.Int32	animationSpeed

Returns

Type	Description
RotatorPropertiesBuilder

AnimationType(String)

Specifies the animationType type for the Rotator Item. animationType options include slide, fastSlide, slowSlide, and other custom easing animationTypes.

Declaration

public RotatorPropertiesBuilder AnimationType(string animationType)

Parameters

Type	Name	Description
System.String	animationType

Returns

Type	Description
RotatorPropertiesBuilder

CircularMode()

Enables the circular mode item rotation.

Declaration

public RotatorPropertiesBuilder CircularMode()

Returns

Type	Description
RotatorPropertiesBuilder

CircularMode(Boolean)

Enables the circular mode item rotation.with boolean argument.

Declaration

public RotatorPropertiesBuilder CircularMode(bool circularMode)

Parameters

Type	Name	Description
System.Boolean	circularMode

Returns

Type	Description
RotatorPropertiesBuilder

ClientSideEvents(Action<RotatorClientSideEventsBuilder>)

ClientSide Events for RotatorPropertiesBuilder

Declaration

public RotatorPropertiesBuilder ClientSideEvents(Action<RotatorClientSideEventsBuilder> clientSideEvents)

Parameters

Type	Name	Description
System.Action<RotatorClientSideEventsBuilder>	clientSideEvents

Returns

Type	Description
RotatorPropertiesBuilder

CssClass(String)

Specify the CSS class to Rotator to achieve custom theme.

Declaration

public RotatorPropertiesBuilder CssClass(string customCssClass)

Parameters

Type	Name	Description
System.String	customCssClass

Returns

Type	Description
RotatorPropertiesBuilder

Datasource(DataSource)

Specify the list of data which contains a set of data fields. Each data value is used to render an item for the Rotator.with object argument.

Declaration

public RotatorPropertiesBuilder Datasource(DataSource dataSource)

Parameters

Type	Name	Description
DataSource	dataSource

Returns

Type	Description
RotatorPropertiesBuilder

Datasource(Action<DataSourceBuilder>)

Specify the list of data which contains a set of data fields. Each data value is used to render an item for the Rotator.with array argument.

Declaration

public RotatorPropertiesBuilder Datasource(Action<DataSourceBuilder> dataSource)

Parameters

Type	Name	Description
System.Action<DataSourceBuilder>	dataSource

Returns

Type	Description
RotatorPropertiesBuilder

Datasource(IEnumerable)

Specify the list of data which contains a set of data fields. Each data value is used to render an item for the Rotator.with IEnumerable argument.

Declaration

public RotatorPropertiesBuilder Datasource(IEnumerable dataSource)

Parameters

Type	Name	Description
System.Collections.IEnumerable	dataSource

Returns

Type	Description
RotatorPropertiesBuilder

Delay(Int32)

Sets the delay between the Rotator Items move after the slide transition.

Declaration

public RotatorPropertiesBuilder Delay(int delay)

Parameters

Type	Name	Description
System.Int32	delay

Returns

Type	Description
RotatorPropertiesBuilder

DisplayItemCount(String)

Specifies the number of Rotator Items to be displayed.

Declaration

public RotatorPropertiesBuilder DisplayItemCount(string displayItemCount)

Parameters

Type	Name	Description
System.String	displayItemCount

Returns

Type	Description
RotatorPropertiesBuilder

EnableAutoPlay()

Rotates the Rotator Items continuously without user interference.

Declaration

public RotatorPropertiesBuilder EnableAutoPlay()

Returns

Type	Description
RotatorPropertiesBuilder

EnableAutoPlay(Boolean)

Rotates the Rotator Items continuously without user interference.with boolean argument.

Declaration

public RotatorPropertiesBuilder EnableAutoPlay(bool enableAutoPlay)

Parameters

Type	Name	Description
System.Boolean	enableAutoPlay

Returns

Type	Description
RotatorPropertiesBuilder

Enabled()

Enables or disables the Rotator control.

Declaration

public RotatorPropertiesBuilder Enabled()

Returns

Type	Description
RotatorPropertiesBuilder

Enabled(Boolean)

Enables or disables the Rotator control.with boolean argument.

Declaration

public RotatorPropertiesBuilder Enabled(bool enabled)

Parameters

Type	Name	Description
System.Boolean	enabled

Returns

Type	Description
RotatorPropertiesBuilder

EnableResize()

The following property has deprecated, we have added 'IsResponsive' API to achieve this behavior. Resizes the Rotator when the browser is resized.

Declaration

[Obsolete("The EnableResize property has been deprecated.Use 'IsResponsive' instead of EnableResize")]
public RotatorPropertiesBuilder EnableResize()

Returns

Type	Description
RotatorPropertiesBuilder

EnableResize(Boolean)

The following property has deprecated, we have added 'IsResponsive' API to achieve this behavior.

Declaration

public RotatorPropertiesBuilder EnableResize(bool isResponsive)

Parameters

Type	Name	Description
System.Boolean	isResponsive

Returns

Type	Description
RotatorPropertiesBuilder

EnableRTL()

Specifies right to left transition of slides.

Declaration

public RotatorPropertiesBuilder EnableRTL()

Returns

Type	Description
RotatorPropertiesBuilder

EnableRTL(Boolean)

Specifies right to left transition of slides.with boolean argument.

Declaration

public RotatorPropertiesBuilder EnableRTL(bool enableRTL)

Parameters

Type	Name	Description
System.Boolean	enableRTL

Returns

Type	Description
RotatorPropertiesBuilder

EnableTouch()

Enables the touch mode item rotation.

Declaration

public RotatorPropertiesBuilder EnableTouch()

Returns

Type	Description
RotatorPropertiesBuilder

EnableTouch(Boolean)

Enables the touch mode item rotation.with boolean argument.

Declaration

public RotatorPropertiesBuilder EnableTouch(bool enableTouch)

Parameters

Type	Name	Description
System.Boolean	enableTouch

Returns

Type	Description
RotatorPropertiesBuilder

FrameSpace(String)

Sets the space between the Rotator Items.

Declaration

public RotatorPropertiesBuilder FrameSpace(string frameSpace)

Parameters

Type	Name	Description
System.String	frameSpace

Returns

Type	Description
RotatorPropertiesBuilder

HtmlAttributes(IDictionary<String, Object>)

Specifies the list of html attributes to be add rotator control.

Declaration

public RotatorPropertiesBuilder HtmlAttributes(IDictionary<string, object> itemHtmlAttributes)

Parameters

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

Returns

Type	Description
RotatorPropertiesBuilder

IsResponsive()

Resizes the Rotator when the browser is resized.

Declaration

public RotatorPropertiesBuilder IsResponsive()

Returns

Type	Description
RotatorPropertiesBuilder

IsResponsive(Boolean)

Resizes the Rotator when the browser is resized.with boolean argument.

Declaration

public RotatorPropertiesBuilder IsResponsive(bool isResponsive)

Parameters

Type	Name	Description
System.Boolean	isResponsive

Returns

Type	Description
RotatorPropertiesBuilder

Items(Action<RotatorBaseItemAdder>)

Specifies the items of the Rotator.

Declaration

public RotatorPropertiesBuilder Items(Action<RotatorBaseItemAdder> items)

Parameters

Type	Name	Description
System.Action<RotatorBaseItemAdder>	items

Returns

Type	Description
RotatorPropertiesBuilder

NavigateSteps(String)

Specifies the number of Rotator Items to navigate on a single click (next/previous/play buttons). The navigateSteps property value must be less than or equal to the displayItemsCount property value.

Declaration

public RotatorPropertiesBuilder NavigateSteps(string navigateSteps)

Parameters

Type	Name	Description
System.String	navigateSteps

Returns

Type	Description
RotatorPropertiesBuilder

Orientation(Orientation)

Specifies the orientation for the Rotator control, that is, whether it must be rendered horizontally or vertically.

Declaration

public RotatorPropertiesBuilder Orientation(Orientation orientation)

Parameters

Type	Name	Description
Orientation	orientation

Returns

Type	Description
RotatorPropertiesBuilder

PagerPosition(PagerPosition)

Specifies the position of the showPager in the Rotator Item.

Declaration

public RotatorPropertiesBuilder PagerPosition(PagerPosition pagerPosition)

Parameters

Type	Name	Description
PagerPosition	pagerPosition

Returns

Type	Description
RotatorPropertiesBuilder

Query(String)

Retrieves data from remote data. This property is applicable only when a remote data source is used.

Declaration

public RotatorPropertiesBuilder Query(string query)

Parameters

Type	Name	Description
System.String	query

Returns

Type	Description
RotatorPropertiesBuilder

Render()

Declaration

public void Render()

RotatorFields(Action<RotatorFieldsBuilder>)

Defines mapping fields for the data items of the Rotator.

Declaration

public RotatorPropertiesBuilder RotatorFields(Action<RotatorFieldsBuilder> fields)

Parameters

Type	Name	Description
System.Action<RotatorFieldsBuilder>	fields

Returns

Type	Description
RotatorPropertiesBuilder

ShowCaption()

If the Rotator Item is an image, you can specify a caption for the Rotator Item. The caption text for each Rotator Item must be set by using the title attribute of the respective tag. The caption cannot be displayed if multiple Rotator Items are present.

Declaration

public RotatorPropertiesBuilder ShowCaption()

Returns

Type	Description
RotatorPropertiesBuilder

ShowCaption(Boolean)

If the Rotator Item is an image, you can specify a caption for the Rotator Item. The caption text for each Rotator Item must be set by using the title attribute of the respective tag. The caption cannot be displayed if multiple Rotator Items are present.with boolean argument.

Declaration

public RotatorPropertiesBuilder ShowCaption(bool showCaption)

Parameters

Type	Name	Description
System.Boolean	showCaption

Returns

Type	Description
RotatorPropertiesBuilder

ShowNavigateButton()

Turns on or off the slide buttons (next and previous) in the Rotator Items. Slide buttons are used to navigate the Rotator Items.

Declaration

public RotatorPropertiesBuilder ShowNavigateButton()

Returns

Type	Description
RotatorPropertiesBuilder

ShowNavigateButton(Boolean)

Turns on or off the slide buttons (next and previous) in the Rotator Items. Slide buttons are used to navigate the Rotator Items.with boolean argument.

Declaration

public RotatorPropertiesBuilder ShowNavigateButton(bool showNavigateButton)

Parameters

Type	Name	Description
System.Boolean	showNavigateButton

Returns

Type	Description
RotatorPropertiesBuilder

ShowPager()

Turns on or off the pager support in the Rotator control. The Pager is used to navigate the Rotator Items.

Declaration

public RotatorPropertiesBuilder ShowPager()

Returns

Type	Description
RotatorPropertiesBuilder

ShowPager(Boolean)

Turns on or off the pager support in the Rotator control. The Pager is used to navigate the Rotator Items.with boolean argument.

Declaration

public RotatorPropertiesBuilder ShowPager(bool showPager)

Parameters

Type	Name	Description
System.Boolean	showPager

Returns

Type	Description
RotatorPropertiesBuilder

ShowPlayButton()

Enable play / pause button on rotator.

Declaration

public RotatorPropertiesBuilder ShowPlayButton()

Returns

Type	Description
RotatorPropertiesBuilder

ShowPlayButton(Boolean)

Enable play / pause button on rotator.with boolean argument.

Declaration

public RotatorPropertiesBuilder ShowPlayButton(bool showPlayButton)

Parameters

Type	Name	Description
System.Boolean	showPlayButton

Returns

Type	Description
RotatorPropertiesBuilder

ShowThumbnail()

Turns on or off thumbnail support in the Rotator control. Thumbnail is used to navigate between slides. Thumbnail supports only single slide transition You must specify the source for thumbnail elements through the thumbnailSourceID property.

Declaration

public RotatorPropertiesBuilder ShowThumbnail()

Returns

Type	Description
RotatorPropertiesBuilder

ShowThumbnail(Boolean)

Turns on or off thumbnail support in the Rotator control. Thumbnail is used to navigate between slides. Thumbnail supports only single slide transition You must specify the source for thumbnail elements through the thumbnailSourceID property.with boolean argument.

Declaration

public RotatorPropertiesBuilder ShowThumbnail(bool showThumbnail)

Parameters

Type	Name	Description
System.Boolean	showThumbnail

Returns

Type	Description
RotatorPropertiesBuilder

SlideHeight(String)

Sets the height of a Rotator Item.

Declaration

public RotatorPropertiesBuilder SlideHeight(string slideHeight)

Parameters

Type	Name	Description
System.String	slideHeight

Returns

Type	Description
RotatorPropertiesBuilder

SlideWidth(String)

Sets the width of a Rotator Item.

Declaration

public RotatorPropertiesBuilder SlideWidth(string slideWidth)

Parameters

Type	Name	Description
System.String	slideWidth

Returns

Type	Description
RotatorPropertiesBuilder

StartIndex(String)

Sets the index of the slide that must be displayed first.

Declaration

public RotatorPropertiesBuilder StartIndex(string startIndex)

Parameters

Type	Name	Description
System.String	startIndex

Returns

Type	Description
RotatorPropertiesBuilder

StopOnHover()

Pause the auto play while hover on the rotator content.

Declaration

public RotatorPropertiesBuilder StopOnHover()

Returns

Type	Description
RotatorPropertiesBuilder

StopOnHover(Boolean)

Pause the auto play while hover on the rotator content.with boolean argument.

Declaration

public RotatorPropertiesBuilder StopOnHover(bool stopOnHover)

Parameters

Type	Name	Description
System.Boolean	stopOnHover

Returns

Type	Description
RotatorPropertiesBuilder

Template(String)

Render the rotator control with template via dataSource.

Declaration

public RotatorPropertiesBuilder Template(string template)

Parameters

Type	Name	Description
System.String	template

Returns

Type	Description
RotatorPropertiesBuilder

TemplateId(String)

Render the rotator control with script-jsRender template.

Declaration

public RotatorPropertiesBuilder TemplateId(string templateId)

Parameters

Type	Name	Description
System.String	templateId

Returns

Type	Description
RotatorPropertiesBuilder

ThumbnailSourceID(String)

Specifies the source for thumbnail elements.

Declaration

public RotatorPropertiesBuilder ThumbnailSourceID(string thumbnailSourceID)

Parameters

Type	Name	Description
System.String	thumbnailSourceID

Returns

Type	Description
RotatorPropertiesBuilder

ToHtmlString()

Returns an HTML-encoded string.

Declaration

public string ToHtmlString()

Returns

Type	Description
System.String

Implements

IPropertiesBuilder

System.Web.IHtmlString