Class RotatorProperties

Inheritance
System.Object
EJTagHelper
RotatorProperties
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.Models
Assembly: Syncfusion.EJ.dll
Syntax
public class RotatorProperties : EJTagHelper

Constructors

RotatorProperties()

Declaration
public RotatorProperties()

Properties

AllowKeyboardNavigation

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

Declaration
[JsonProperty("allowKeyboardNavigation")]
public bool AllowKeyboardNavigation { get; set; }
Property Value
Type Description
System.Boolean

AnimationSpeed

Sets the animationSpeed of slide transition.

Declaration
[JsonProperty("animationSpeed")]
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
[JsonProperty("animationType")]
public string AnimationType { get; set; }
Property Value
Type Description
System.String

Change

This event is fired when the Rotator slides are changed.

Declaration
[JsonProperty("change")]
public string Change { get; set; }
Property Value
Type Description
System.String

CircularMode

Enables the circular mode item rotation.

Declaration
[JsonProperty("circularMode")]
public bool CircularMode { get; set; }
Property Value
Type Description
System.Boolean

Create

This event is fired when the Rotator control is initialized.

Declaration
[JsonProperty("create")]
public string Create { get; set; }
Property Value
Type Description
System.String

CssClass

Specify the CSS class to Rotator to achieve custom theme.

Declaration
[JsonProperty("cssClass")]
public string CssClass { get; set; }
Property Value
Type Description
System.String

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.

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

Delay

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

Declaration
[JsonProperty("delay")]
public int Delay { get; set; }
Property Value
Type Description
System.Int32

Destroy

This event is fired when the Rotator control is destroyed.

Declaration
[JsonProperty("destroy")]
public string Destroy { get; set; }
Property Value
Type Description
System.String

DisplayItemCount

Specifies the number of Rotator Items to be displayed.

Declaration
[JsonProperty("displayItemsCount")]
public string DisplayItemCount { get; set; }
Property Value
Type Description
System.String

EmptyDataText

It shows message when no list item is loaded.

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

EnableAnimation

Specifies the animation behavior of the rotator.

Declaration
[JsonProperty("enableAnimation")]
public bool EnableAnimation { get; set; }
Property Value
Type Description
System.Boolean

EnableAutoPlay

Rotates the Rotator Items continuously without user interference.

Declaration
[JsonProperty("enableAutoPlay")]
public bool EnableAutoPlay { get; set; }
Property Value
Type Description
System.Boolean

Enabled

Enables or disables the Rotator control.

Declaration
[JsonProperty("enabled")]
public bool Enabled { get; set; }
Property Value
Type Description
System.Boolean

EnableResize

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

Declaration
[JsonIgnore]
[Obsolete("EnableResize property has been deprecated. Use isResponsive API to achieve this behavior")]
public bool EnableResize { get; set; }
Property Value
Type Description
System.Boolean

EnableRTL

Specifies right to left transition of slides.

Declaration
[JsonProperty("enableRTL")]
public bool EnableRTL { get; set; }
Property Value
Type Description
System.Boolean

EnableTouch

Enables the touch mode item rotation

Declaration
[JsonProperty("enableTouch")]
public bool EnableTouch { get; set; }
Property Value
Type Description
System.Boolean

FrameSpace

Sets the space between the Rotator Items.

Declaration
[JsonProperty("frameSpace")]
public string FrameSpace { get; set; }
Property Value
Type Description
System.String

HtmlAttributes

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

Declaration
[JsonProperty("htmlAttributes")]
public IDictionary<string, object> HtmlAttributes { get; set; }
Property Value
Type Description
System.Collections.Generic.IDictionary<System.String, System.Object>

IsResponsive

Resizes the Rotator when the browser is resized.

Declaration
[JsonProperty("isResponsive")]
public bool IsResponsive { get; set; }
Property Value
Type Description
System.Boolean

Items

Rotator Items

Declaration
[JsonIgnore]
public List<RotatorBaseItem> Items { get; set; }
Property Value
Type Description
System.Collections.Generic.List<RotatorBaseItem>

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
[JsonProperty("navigateSteps")]
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
[JsonProperty("orientation")]
[JsonConverter(typeof(StringEnumConverter))]
public Orientation Orientation { get; set; }
Property Value
Type Description
Orientation

PagerClick

This event is fired when a pager is clicked.

Declaration
[JsonProperty("pagerClick")]
public string PagerClick { get; set; }
Property Value
Type Description
System.String

PagerPosition

Specifies the position of the showPager in the Rotator Item.

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

Query

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

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

RotatorFields

Defines mapping fields for the data items of the Rotator.

Declaration
[JsonProperty("fields")]
public RotatorFields RotatorFields { get; set; }
Property Value
Type Description
RotatorFields

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
[JsonProperty("showCaption")]
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
[JsonProperty("showNavigateButton")]
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
[JsonProperty("showPager")]
public bool ShowPager { get; set; }
Property Value
Type Description
System.Boolean

ShowPlayButton

Enable play / pause button on rotator.

Declaration
[JsonProperty("showPlayButton")]
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
[JsonProperty("showThumbnail")]
public bool ShowThumbnail { get; set; }
Property Value
Type Description
System.Boolean

SlideHeight

Sets the height of a Rotator Item.

Declaration
[JsonProperty("slideHeight")]
public string SlideHeight { get; set; }
Property Value
Type Description
System.String

SlideWidth

Sets the width of a Rotator Item.

Declaration
[JsonProperty("slideWidth")]
public string SlideWidth { get; set; }
Property Value
Type Description
System.String

Start

This event is fired when enableAutoPlay is started.

Declaration
[JsonProperty("start")]
public string Start { get; set; }
Property Value
Type Description
System.String

StartIndex

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

Declaration
[JsonProperty("startIndex")]
public string StartIndex { get; set; }
Property Value
Type Description
System.String

Stop

This event is fired when autoplay is stopped or paused.

Declaration
[JsonProperty("stop")]
public string Stop { get; set; }
Property Value
Type Description
System.String

StopOnHover

Pause the auto play while hover on the rotator content.

Declaration
[JsonProperty("stopOnHover")]
public bool StopOnHover { get; set; }
Property Value
Type Description
System.Boolean

Template

Render the rotator control with template via dataSource.

Declaration
[JsonProperty("template")]
public string Template { get; set; }
Property Value
Type Description
System.String

TemplateId

Render the rotator control with script-jsRender template.

Declaration
[JsonProperty("templateId")]
public string TemplateId { get; set; }
Property Value
Type Description
System.String

ThumbItemClick

This event is fired when a thumbnail pager is clicked.

Declaration
[JsonProperty("thumbItemClick")]
public string ThumbItemClick { get; set; }
Property Value
Type Description
System.String

ThumbnailSourceID

Specifies the source for thumbnail elements.

Declaration
[JsonProperty("thumbnailSourceID")]
public string ThumbnailSourceID { get; set; }
Property Value
Type Description
System.String

Methods

GetControlDetails()

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

ShouldSerializeDataSource()

ShouldSerialize Method for DataSource

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

ShouldSerializeRotatorFields()

ShouldSerialize Method for RotatorFields

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