ClassRadRotator
This control is transfers the web-based rotators' functionality to the Windows forms work space.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
[RadToolboxItem(false)]
[Docking(DockingBehavior.Ask)]
public class RadRotator : RadControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProvider
Inheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadRotator
Implements:
Inherited Members
Constructors
Properties
AnimationFrames
Gets or Sets the swap animation's frames number
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
[Browsable(false)]
public int CurrentIndex { get; set; }
Property Value
CurrentItem
Gets the current item.
Declaration
[Browsable(false)]
public RadItem CurrentItem { get; }
Property Value
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(int)
Declaration
[Browsable(false)]
[RadNewItem("DefaultItem", false)]
public RadItem DefaultItem { get; set; }
Property Value
DefaultSize
Gets the default size of the control.
Declaration
protected override Size DefaultSize { get; }
Property Value
Overrides
Interval
Gets or Sets the interval between consecutive rotation animations.
Items
Gets the collection of RadItems that will be rotated.
Declaration
[Browsable(true)]
public RadItemCollection Items { get; }
Property Value
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)
OpacityAnimation
Gets or Sets value indicating whether opacity will be animated when switching frames
RotatorElement
Gets the instance of RadRotatorElement wrapped by this control. RadRotatorElement is the main element in the hierarchy tree and encapsulates the actual functionality of RadRotator.
Declaration
[Browsable(false)]
public RadRotatorElement RotatorElement { get; }
Property Value
Running
Gets or Sets value indicating whether the RadRotator is started/stopped.
ShouldStopOnMouseOver
Gets or sets whether RadRotator should stop rotating on MouseOver
Declaration
[Browsable(true)]
public bool ShouldStopOnMouseOver { get; set; }
Property Value
Methods
CreateChildItems(RadElement)
Initializes the child Items
Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
parent
Overrides
Goto(int)
Initiates swap between the current item and the one whose index is supplied.
GotoDefault()
Makes transition to the default element.
Declaration
public void GotoDefault()
OnThemeChanged()
Declaration
protected override void OnThemeChanged()
Overrides
Previous()
Moves to the previous item.
Start()
Declaration
public bool Start()
Returns
true if rotation started successfully, false if there are no elements to rotate
Start(bool)
Starts cycling through the elements in the Items collection
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 Value
ItemClicked
Fires when an Item is clicked
StartRotation
Fires when RadRotator is started.
Declaration
public event CancelEventHandler StartRotation
Event Value
StopRotation
Fires when RadRotator is stopped.