Class
RadRotator

RadRotator control.

Definition

Namespace:Telerik.WebAii.Controls.Html

Assembly:Telerik.WebAii.Controls.Html.dll

Syntax:

cs-api-definition
public class RadRotator : HtmlDiv

Inheritance: objectControlHtmlControlHtmlContainerControlHtmlDivRadRotator

Inherited Members HtmlContainerControl.TextContentHtmlContainerControl.InnerTextHtmlControl.FindParentContainer<TContainerControl>()HtmlControl.ValidateTag(string)HtmlControl.ValidateControl()HtmlControl.ParseResponseValue<T>(string, T)HtmlControl.GetAttributeAsString(string)HtmlControl.InitializeMappings(MappingsCollection)HtmlControl.GetRectangle()HtmlControl.IsVisible()HtmlControl.GetStyleValue(string)HtmlControl.GetStyle(string)HtmlControl.GetComputedStyleValue(string)HtmlControl.GetComputedStyle(string)HtmlControl.Parent<TContainerControl>()HtmlControl.Capture()HtmlControl.Capture(string, string)HtmlControl.Capture(string)HtmlControl.InvokeEvent(ScriptEventType)HtmlControl.InvokeEvent(ScriptEventType, bool)HtmlControl.InvokeEvent(ScriptEvent)HtmlControl.InvokeEvent(ScriptEvent, bool)HtmlControl.AddEventListener(string, EventHandler<JavascriptEventArgs>)HtmlControl.RemoveEventListener(string, EventHandler<JavascriptEventArgs>)HtmlControl.MouseClick()HtmlControl.MouseClick(MouseClickType)HtmlControl.MouseClick(MouseClickType, int, int)HtmlControl.MouseClick(MouseClickType, Point, OffsetReference)HtmlControl.MouseClick(MouseClickType, int, int, OffsetReference)HtmlControl.MouseHover()HtmlControl.MouseHover(Point)HtmlControl.MouseHover(int, int)HtmlControl.MouseHover(int, int, OffsetReference)HtmlControl.Click()HtmlControl.Click(bool)HtmlControl.ScrollToVisible()HtmlControl.ScrollToVisible(ScrollToVisibleType)HtmlControl.ScrollToVisible(ScrollToVisibleType, Rectangle)HtmlControl.Download(bool, DownloadOption, string, int)HtmlControl.CallMethod(string)HtmlControl.CallMethod<T>(string)HtmlControl.CallMethod<T>(string, T)HtmlControl.GetValue<T>(string)HtmlControl.GetValue<T>(string, T)HtmlControl.GetValue<T>(string, bool)HtmlControl.GetValue<T>(string, bool, T)HtmlControl.SetValue<T>(string, T)HtmlControl.SetValue<T>(string, T, bool)HtmlControl.Focus()HtmlControl.DragTo(OffsetReference, Point, int, int)HtmlControl.DragTo(OffsetReference, int, int, Rectangle, OffsetReference, int, int)HtmlControl.DragTo(Point)HtmlControl.DragTo(int, int)HtmlControl.DragTo(HtmlControl)HtmlControl.DragTo(HtmlControl, OffsetReference, Point)HtmlControl.DragTo(OffsetReference, Point, HtmlControl)HtmlControl.DragTo(OffsetReference, Point, HtmlControl, OffsetReference, Point)HtmlControl.DragTo(OffsetReference, int, int, bool, HtmlControl, OffsetReference, int, int, bool)HtmlControl.DragToWindowLocation(OffsetReference, int, int, bool, OffsetReference, int, int, bool)HtmlControl.ToString()HtmlControl.AsjQueryControl()HtmlControl.GetElementByTagNameClientSideLocatorHtmlControl.GetElementByIdClientSideLocatorHtmlControl.FindHtmlControl.ScrollTopHtmlControl.ScrollLeftHtmlControl.WaitHtmlControl.IDHtmlControl.CssClassHtmlControl.AttributesHtmlControl.MappingsHtmlControl.StylesHtmlControl.EventsHtmlControl.TagNameHtmlControl.ChildNodesHtmlControl.IsActiveElementHtmlControl.IsEnabledControl.Refresh()Control.AssignFailed(Exception)Control.SetTelerikComponentsVersion(TelerikComponentsVersion?)Control.MatchControl(Element, FindParam)Control.GetFamilyElement(int, Element)Control.ThrowOnInvalidAssignmentControl.TelerikComponentsVersionControl.IsRefreshControl.BaseElementControl.OwnerBrowserControl.Locator

Constructors

RadRotator()

Initializes a new instance of the RadRotator class.

Declaration

cs-api-definition
public RadRotator()

RadRotator(Element)

Initializes a new instance of the RadRotator class.

Declaration

cs-api-definition
public RadRotator(Element element)

Parameters

element

Element

Properties

AnimationDirection

Gets/Sets the animation direction.

Declaration

cs-api-definition
public int AnimationDirection { get; set; }

Property Value

int

ClientSideLocator

Gets the locator FindParam.

Declaration

cs-api-definition
public override string ClientSideLocator { get; }

Property Value

string

Overrides HtmlControl.ClientSideLocator

CurrentItemIndex

Gets/Sets the current item index.

Declaration

cs-api-definition
public int CurrentItemIndex { get; set; }

Property Value

int

FrameDuration

Gets/Sets the time in milliseconds each frame will displays in automatic scrolling scenarios.

Declaration

cs-api-definition
public int FrameDuration { get; set; }

Property Value

int

Height

Gets/Sets the Rotator height in pixels.

Declaration

cs-api-definition
public int Height { get; set; }

Property Value

int

InitialItemIndex

Gets/Sets the initial item index.

Declaration

cs-api-definition
public int InitialItemIndex { get; set; }

Property Value

int

IsAutomaticAdvance

Determines whether the rotator is set in AutomaticAdvance mode.

Declaration

cs-api-definition
public bool IsAutomaticAdvance { get; }

Property Value

bool

IsPaused

Determines whether the RadRotator is paused or not.

Declaration

cs-api-definition
public bool IsPaused { get; }

Property Value

bool

IsScrollingForward

Determines whether the rotator is scrolling forward.

Declaration

cs-api-definition
public bool IsScrollingForward { get; }

Property Value

bool

IsScrollingLeft

Determines whether the rotator is scrolling to the left.

Declaration

cs-api-definition
public bool IsScrollingLeft { get; }

Property Value

bool

IsScrollingUp

Determines whether the rotator is scrolling upward.

Declaration

cs-api-definition
public bool IsScrollingUp { get; }

Property Value

bool

IsSlideShow

Determines whether the rotator is set in SlideShow mode.

Declaration

cs-api-definition
public bool IsSlideShow { get; }

Property Value

bool

IsVertical

Determines whether the rotator is vertical.

Declaration

cs-api-definition
public bool IsVertical { get; }

Property Value

bool

IsViewportScrollMode

Determines whether the rotator is scrolling item by item or it is scrolling the whole viewport.

Declaration

cs-api-definition
public bool IsViewportScrollMode { get; }

Property Value

bool

ItemCount

Gets the item count of the Rotator.

Declaration

cs-api-definition
public int ItemCount { get; }

Property Value

int

LocatorExpression

Gets the locator HtmlFindExpression.

Declaration

cs-api-definition
public override IFindExpression LocatorExpression { get; }

Property Value

IFindExpression

Overrides Control.LocatorExpression

PauseOnMouseOver

Determines or set whether the scrolling pauses on mouse over.

Declaration

cs-api-definition
public bool PauseOnMouseOver { get; set; }

Property Value

bool

RotatorType

Gets/Sets the rotator type.

Declaration

cs-api-definition
public RotatorType RotatorType { get; set; }

Property Value

RotatorType

ScrollDirection

Gets/Sets the rotator scrolling direction.

Declaration

cs-api-definition
public RotatorScrollDirection ScrollDirection { get; set; }

Property Value

RotatorScrollDirection

ScrollDuration

Gets/Sets the speed in milliseconds for scrolling rotator items.

Declaration

cs-api-definition
public int ScrollDuration { get; set; }

Property Value

int

Width

Gets/Sets the Rotator width in pixels.

Declaration

cs-api-definition
public int Width { get; set; }

Property Value

int

WrapFrames

Determines or set whether to start scrolling the frames from the beginning as soon as the rotator shows the last frame.

Declaration

cs-api-definition
public bool WrapFrames { get; set; }

Property Value

bool

Methods

AssignElement(Element)

Assign the control element.

Declaration

cs-api-definition
public override void AssignElement(Element e)

Parameters

e

Element

The underlying element object.

Overrides HtmlDiv.AssignElement(Element)

ControlAssert()

Gets RadControlAssert instance initialized for this control.

Declaration

cs-api-definition
public RadControlAssert ControlAssert()

Returns

RadControlAssert

RadControlAssert instance initialized for this control.

Pause()

Pauses the animation.

Declaration

cs-api-definition
public void Pause()

Resume()

Resumes the paused animation.

Declaration

cs-api-definition
public void Resume()

Scroll(RotatorScrollDirection)

Scrolls the rotator according to the given direction. Accepts 'Left', 'Right', 'Up' and 'Down' scroll direction arguments.

Declaration

cs-api-definition
public void Scroll(RotatorScrollDirection direction)

Parameters

direction

RotatorScrollDirection

ScrollItem()

Scrolls the rotator item.

Declaration

cs-api-definition
public void ScrollItem()

ScrollViewPort()

Scrolls the rotator view port.

Declaration

cs-api-definition
public void ScrollViewPort()

Start()

Starts the animation.

Declaration

cs-api-definition
public void Start()

StartAutoPlay()

Starts auto playing the rotator items.

Declaration

cs-api-definition
public void StartAutoPlay()

Stop()

Stops the animation.

Declaration

cs-api-definition
public void Stop()

StopViewportAnimation()

If an item is partially shown and the rotator is paused, calling this function will force the rotator to fully display the item.

Declaration

cs-api-definition
public void StopViewportAnimation()