Class RadRotatorElement

The RadItem containing RadRotatorItem, Border and Fill primitives

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
RadRotatorElement
Inherited Members
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: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public class RadRotatorElement : RadItem, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode

Constructors

RadRotatorElement()

Declaration
public RadRotatorElement()

Properties

AnimationFrames

Gets or Sets the swap animation's frames number

Declaration
public int AnimationFrames { get; set; }
Property Value
System.Int32

CurrentIndex

Gets or Sets the index of the current item. Note: When setting the current item, the old and the new item will be swapped.

Declaration
public int CurrentIndex { get; set; }
Property Value
System.Int32

CurrentItem

Gets the current item.

Declaration
public RadItem CurrentItem { get; }
Property Value
RadItem

DefaultItem

Gets or Sets the RadItem that is to be displayed while loading the rest items. It is not cycled through when rotation starts. If you want to have initial item that will be cycled through, add it to the Items collection and advance to it using Goto(Int32)

Declaration
public RadItem DefaultItem { get; set; }
Property Value
RadItem

Interval

Gets or Sets the interval between consecutive rotation animations.

Declaration
public int Interval { get; set; }
Property Value
System.Int32

Items

Gets the collection of RadItems that will be rotated.

Declaration
public RadItemOwnerCollection Items { get; }
Property Value
RadItemOwnerCollection

LocationAnimation

Gets or Sets value defining the initial position of the incoming item and the final position of the outgoing item. Note: The position is relative, in the range [-1, 1] for each of the components (X, Y). Value of positive or negative 1 means that the object will not be in the visible area before the animation begins (for the incoming item) or after it ends (for the outgoing item)

Declaration
public SizeF LocationAnimation { get; set; }
Property Value
System.Drawing.SizeF

OpacityAnimation

Gets or Sets value indicating whether opacity will be animated when switching frames

Declaration
public bool OpacityAnimation { get; set; }
Property Value
System.Boolean

RotatorItem

Gets the RadRotatorItem in the current RadElement

Declaration
public RadRotatorItem RotatorItem { get; }
Property Value
RadRotatorItem

Running

Gets or Sets value indicating whether the RadRotator is started/stopped.

Declaration
public bool Running { get; set; }
Property Value
System.Boolean

ShouldStopOnMouseOver

Gets or sets whether RadRotator should stop rotating on MouseOver

Declaration
public bool ShouldStopOnMouseOver { get; set; }
Property Value
System.Boolean

Methods

CreateChildElements()

Called by the element when constructed. Allows inheritors to build the element tree.

Declaration
protected override void CreateChildElements()
Overrides

Goto(Int32)

Initiates swap between the current item and the one whose index is supplied.

Declaration
public bool Goto(int index)
Parameters
System.Int32 index

the index of the item in the Items collection. The index of the home element is -1.
Returns
System.Boolean

true on successful swap

GotoDefault()

Makes transition to the default element.

Declaration
public bool GotoDefault()
Returns
System.Boolean

InitializeFields()

Declaration
protected override void InitializeFields()
Overrides

Next()

Moves to the next item,

Declaration
public bool Next()
Returns
System.Boolean

Previous()

Moves to the previous item.

Declaration
public bool Previous()
Returns
System.Boolean

Start(Boolean)

Starts cycling through the elements in the Items collection

Declaration
public bool Start(bool startImmediately)
Parameters
System.Boolean startImmediately

set to true to initiate rotation immediately, or set to false to rotate after the time Interval
Returns
System.Boolean

there are no elements to rotate (Items collection is empty)

Stop()

Stops the rotation process. If swap is under way, it will be completed.

Declaration
public void Stop()

Events

BeginRotate

Fires before RadItems' swap begins.

Declaration
public event BeginRotateEventHandler BeginRotate
Event Type
BeginRotateEventHandler

EndRotate

Fires when RadItems' swap has finished.

Declaration
public event EventHandler EndRotate
Event Type
System.EventHandler

ItemClicked

Fires when an Item is clicked

Declaration
public event EventHandler ItemClicked
Event Type
System.EventHandler

StartRotation

Fires when RadRotator is started.

Declaration
public event CancelEventHandler StartRotation
Event Type
System.ComponentModel.CancelEventHandler

StopRotation

Fires when RadRotator is stopped.

Declaration
public event EventHandler StopRotation
Event Type
System.EventHandler

Extension Methods