Class Rotator

Inheritance
System.Object
CommonDataBoundControl
Rotator
Implements
System.Web.UI.INamingContainer
System.Web.UI.IPostBackEventHandler
System.Web.UI.IPostBackDataHandler
System.Web.UI.IUrlResolutionService
Inherited Members
Namespace: Syncfusion.JavaScript.Web
Assembly: Syncfusion.EJ.Web.dll
Syntax
public class Rotator : CommonDataBoundControl, INamingContainer, IPostBackEventHandler, IPostBackDataHandler, IUrlResolutionService

Constructors

Rotator()

Declaration
public Rotator()

Properties

AllowKeyboardNavigation

Turns on keyboard interaction with the Rotator items.

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

AnimationSpeed

Sets the AnimationSpeed of the slide transition.

Declaration
public int AnimationSpeed { get; set; }
Property Value
Type Description
System.Int32

AnimationType

Specifies the AnimationType type for the Rotator Item. AnimationType options include Slide, FastSlide, SlowSlide, and other custom easing AnimationTypes.

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

CircularMode

Enables the circular mode item rotation.

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

ClientSideOnChange

This event is fired when the Rotator slides are changed.

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

ClientSideOnCreate

This event is fired when the Rotator control is initialized.

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

ClientSideOnDestroy

This event is fired when the Rotator control is destroyed.

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

ClientSideOnPagerClick

This event is fired when a thumbnail pager is clicked.

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

ClientSideOnStart

This event is fired when EnableAutoPlay is started.

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

ClientSideOnStop

This event is fired when AutoPlay is stopped or paused.

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

ClientSideOnThumbClick

This event is fired when a thumbnail item is clicked.

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

CssClass

Specifies the CSS class to Rotator to achieve custom theme.

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

DataCaptionField

Mapping Field for Caption property.

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

DataSource

Get or set Datasource object

Declaration
[JsonConverter(typeof(DataManagerConverter))]
public object DataSource { get; set; }
Property Value
Type Description
System.Object

DataSourceCachingMode

Gets or sets property for DataSourceCachingMode.

Declaration
public DataSourceCachingMode DataSourceCachingMode { get; set; }
Property Value
Type Description
DataSourceCachingMode

DataThumbnailCaptionField

Mapping Field for ThumbnailCaption property

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

DataThumbnailUrlField

Mapping Field for ThumbnailUrl property.

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

DataUrlField

Mapping Field for Url property.

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

Delay

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

Declaration
public int Delay { get; set; }
Property Value
Type Description
System.Int32

DisplayItemCount

Specifies the number of Rotator Items to be displayed.

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

EmptyDataText

Specifies the error message for Rotator.

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

EnableAutoPlay

Rotates the Rotator Items continuously without user interference.

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

Enabled

Specifies whether to enables or disables the Rotator control.

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

EnableResize

It's depreciated, we have added 'ShowAudioButton' API to achieve this behavior

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

EnableRTL

Gets whether the translation by the control is displayed from right to left.

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

EnableTouch

Turns on touch interaction with the Rotator items.

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

Fields

Specifies the fields property for map the items.

Declaration
public RotatorFields Fields { get; }
Property Value
Type Description
RotatorFields

FrameSpace

Sets the space between the Rotator Items.

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

IsResponsive

Resizes the Rotator when the browser is resized.

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

Items

Collection of items.

Declaration
public List<RotatorItem> Items { get; }
Property Value
Type Description
System.Collections.Generic.List<RotatorItem>

Model

Gets or sets the data's to the model .

Declaration
public RotatorProperties Model { get; set; }
Property Value
Type Description
RotatorProperties

NavigateSteps

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 string NavigateSteps { get; set; }
Property Value
Type Description
System.String

Orientation

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

Declaration
[JsonConverter(typeof(StringEnumConverter))]
public Orientation Orientation { get; set; }
Property Value
Type Description
Orientation

PagerPosition

Specifies the position of the ShowPager in the Rotator Item. It accepts the BottomLeft,BottomRight,Outside,TopCentre,TopLeft,TopRight types.

Declaration
[JsonConverter(typeof(StringEnumConverter))]
public PagerPosition PagerPosition { get; set; }
Property Value
Type Description
PagerPosition

Query

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

Declaration
[JsonConverter(typeof(QueryConverter))]
public string Query { get; set; }
Property Value
Type Description
System.String

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 bool ShowCaption { get; set; }
Property Value
Type Description
System.Boolean

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 bool ShowNavigateButton { get; set; }
Property Value
Type Description
System.Boolean

ShowPager

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

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

ShowPlayButton

Enables play/pause button on the Rotator.

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

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 bool ShowThumbnail { get; set; }
Property Value
Type Description
System.Boolean

SlideHeight

Sets the height of a Rotator Item.

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

SlideWidth

Sets the width of a Rotator Item.

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

StartIndex

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

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

StopOnHover

Pause the auto play while hovering on the rotator content.

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

Template

Render the rotator control with template via dataSource.

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

TemplateId

Render the rotator control with script-jsRender template.

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

ThumbItems

Collection of thumbitems.

Declaration
public List<ThumbItem> ThumbItems { get; }
Property Value
Type Description
System.Collections.Generic.List<ThumbItem>

thumbnailSourceID

Specifies the source for thumbnail elements.

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

Methods

DependentScripts()

Declaration
public List<string> DependentScripts()
Returns
Type Description
System.Collections.Generic.List<System.String>

FetchData(IEnumerable)

Declaration
public override void FetchData(IEnumerable data)
Parameters
Type Name Description
System.Collections.IEnumerable data
Overrides

GetDependentFiles()

Declaration
public override List<string> GetDependentFiles()
Returns
Type Description
System.Collections.Generic.List<System.String>
Overrides

LoadViewState(Object)

Restores view-state information from a previous page request.

Declaration
protected override void LoadViewState(object state)
Parameters
Type Name Description
System.Object state
Overrides

Render()

Declaration
public string Render()
Returns
Type Description
System.String

Render(HtmlTextWriter)

Declaration
protected override void Render(HtmlTextWriter writer)
Parameters
Type Name Description
System.Web.UI.HtmlTextWriter writer
Overrides

SaveViewState()

Declaration
protected override object SaveViewState()
Returns
Type Description
System.Object

Implements

System.Web.UI.INamingContainer
System.Web.UI.IPostBackEventHandler
System.Web.UI.IPostBackDataHandler
System.Web.UI.IUrlResolutionService