Class RadCarouselElement

RadElement that animates a list of items using Carousel-style view, used by RadCarousel control

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
RadCarouselElement
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 RadCarouselElement : RadItem, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IBindableComponent, IComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IDisposable

Constructors

RadCarouselElement()

Declaration
public RadCarouselElement()

Properties

AnimationDelay

Set ot get the Carousel animation frames delay

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

AnimationFrames

Set ot get the Carousel animation frames

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

AutoLoopPauseInterval

Gets or sets a value indicating the interval (in seconds) after which the carousel will resume looping when in auto-loop mode.

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

ButtonNext

Pressent the Next button

Declaration
public RadRepeatButtonElement ButtonNext { get; }
Property Value
RadRepeatButtonElement

ButtonPositions

Represent the Navigation buttons Possitions

Declaration
public virtual NavigationButtonsPosition ButtonPositions { get; set; }
Property Value
NavigationButtonsPosition

ButtonPrevious

Present the Previous button

Declaration
public RadRepeatButtonElement ButtonPrevious { get; }
Property Value
RadRepeatButtonElement

CarouselItemContainer

Declaration
public CarouselItemsContainer CarouselItemContainer { get; }
Property Value
CarouselItemsContainer

CaseSensitive

Gets or sets a value indicating whether sorting of carousel items is case-sensitive.

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

DataManager

Declaration
protected virtual CurrencyManager DataManager { get; }
Property Value
System.Windows.Forms.CurrencyManager

DataSource

Gets or sets the data source that the carousel will bind to.

Declaration
public object DataSource { get; set; }
Property Value
System.Object

EnableKeyboardNavigation

Gets or sets a value indicating whether the keyboard navigation is enabled.

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

FormattingEnabled

Gets or sets a value indicating whether formatting is applied to the DisplayMember property.

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

ItemClickDefaultAction

Gets or sets the default action when item is clicked as CarouselItemClickAction member.

Declaration
public CarouselItemClickAction ItemClickDefaultAction { get; set; }
Property Value
CarouselItemClickAction

The item click default action.

ItemReflectionPercentage

Gets or sets value indicating the height (in percentage - values from 0.0. to 1.0) of reflection that will be painted bellow each carousel item.

Declaration
public double ItemReflectionPercentage { get; set; }
Property Value
System.Double

The item reflection percentage.
Remarks

0.0 indicates no reflection and 1.0 indicates 100% of the height of the original item

Items

Gets a collection of RadItem objects managed by RadCarousel.

Declaration
public RadItemCollection Items { get; }
Property Value
RadItemCollection

Remarks

Items are populated automatically when RadCarousel is data-bound. When using Virtualized, carousel displays only VisibleItemCount number of items at a time.

ItemsContainer

Gets the element, which contains all visible carousel items

Declaration
public CarouselItemsContainer ItemsContainer { get; }
Property Value
CarouselItemsContainer

NavigationButtonsOffset

Get or sets the minimum size to apply on an element when layout is calculated.

Declaration
public virtual Size NavigationButtonsOffset { get; set; }
Property Value
System.Drawing.Size

SelectedIndex

Gets or sets the index the currently selected item.

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

SelectedItem

Gets or sets the item in the carousel that is currently selected.

Declaration
public virtual object SelectedItem { get; set; }
Property Value
System.Object

SelectedValue

Gets or sets a value defining the currently selected item.

Declaration
public object SelectedValue { get; set; }
Property Value
System.Object

ValueMember

Gets or sets the field from the data source to use as the actual value for the carousel items.

Declaration
public string ValueMember { get; set; }
Property Value
System.String

Methods

ArrangeOverride(SizeF)

Declaration
protected override SizeF ArrangeOverride(SizeF finalSize)
Parameters
System.Drawing.SizeF finalSize

Returns
System.Drawing.SizeF

Overrides

BeginUpdate()

Initiates batch update of the items.

Declaration
public void BeginUpdate()

CreateChildElements()

Declaration
protected override void CreateChildElements()
Overrides

CreateNewCarouselItem()

Declaration
protected virtual RadItem CreateNewCarouselItem()
Returns
RadItem

DataManagerItemChanged()

Declaration
protected virtual void DataManagerItemChanged()

DataManagerItemChanged(Object, ItemChangedEventArgs)

Declaration
protected virtual void DataManagerItemChanged(object sender, ItemChangedEventArgs e)
Parameters
System.Object sender

System.Windows.Forms.ItemChangedEventArgs e

DataManagerPositionChanged(Object, EventArgs)

Declaration
protected virtual void DataManagerPositionChanged(object sender, EventArgs e)
Parameters
System.Object sender

System.EventArgs e

EndUpdate()

Ends batch update of the items.

Declaration
public void EndUpdate()

FindItemContaining(String)

Finds the first item in the list with Text containing the specified string.

Declaration
public RadItem FindItemContaining(string subString)
Parameters
System.String subString

The string to search for.
Returns
RadItem

The zero-based index of the first item found; returns null if no match is found.

FindItemExact(String)

Finds the first item in the list box that matches the specified string.

Declaration
public RadItem FindItemExact(string text)
Parameters
System.String text

The string to search for.
Returns
RadItem

The zero-based index of the first item found; returns null if no match is found.

FindItemStartingWith(String)

Finds the first item in the list with Text that starts with the specified string.

Declaration
public RadItem FindItemStartingWith(string startsWith)
Parameters
System.String startsWith

The string to search for.
Returns
RadItem

The zero-based index of the first item found; returns null if no match is found.

GetItemValue(Object)

Gets the value of the given item.

Declaration
public virtual object GetItemValue(object item)
Parameters
System.Object item

Returns
System.Object

InitializeFields()

Declaration
protected override void InitializeFields()
Overrides

IsInputKey(InputKeyEventArgs)

Declaration
protected override bool IsInputKey(InputKeyEventArgs e)
Parameters
InputKeyEventArgs e

Returns
System.Boolean

Overrides

OnAnimationFinished()

Declaration
public virtual void OnAnimationFinished()

OnAnimationStarted()

Declaration
public virtual void OnAnimationStarted()

OnItemDataBound(ItemDataBoundEventArgs)

Raises the ItemDataBound event.

Declaration
protected virtual void OnItemDataBound(ItemDataBoundEventArgs e)
Parameters
ItemDataBoundEventArgs e

OnItemEntering(ItemEnteringEventArgs)

Fires the ItemEntering event

Declaration
protected void OnItemEntering(ItemEnteringEventArgs args)
Parameters
ItemEnteringEventArgs args

Event specific arguemtns

OnItemLeaving(ItemLeavingEventArgs)

Fires the ItemLeaving event

Declaration
protected void OnItemLeaving(ItemLeavingEventArgs args)
Parameters
ItemLeavingEventArgs args

Event specific arguemtns

OnLoaded()

Declaration
protected override void OnLoaded()
Overrides

OnNewCarouselItemCreating(NewCarouselItemCreatingEventArgs)

Raises the CreateNewCarouselItem event.

Declaration
protected virtual void OnNewCarouselItemCreating(NewCarouselItemCreatingEventArgs e)
Parameters
NewCarouselItemCreatingEventArgs e

OnNotifyPropertyChanged(String)

Declaration
protected override void OnNotifyPropertyChanged(string propertyName)
Parameters
System.String propertyName

Overrides

OnPanGesture(PanGestureEventArgs)

Declaration
protected override void OnPanGesture(PanGestureEventArgs args)
Parameters
PanGestureEventArgs args

Overrides

OnPropertyChanged(RadPropertyChangedEventArgs)

Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

Overrides

OnSelectedIndexChanged(SelectedIndexChangedEventArgs)

Raises the SelectedIndexChanged event.

Declaration
protected virtual void OnSelectedIndexChanged(SelectedIndexChangedEventArgs e)
Parameters
SelectedIndexChangedEventArgs e

OnSelectedItemChanged(EventArgs)

Raises the SelectedItemChanged event.

Declaration
protected virtual void OnSelectedItemChanged(EventArgs e)
Parameters
System.EventArgs e

OnSelectedValueChanged(EventArgs)

Raises the SelectedValueChanged event.

Declaration
protected virtual void OnSelectedValueChanged(EventArgs e)
Parameters
System.EventArgs e

ProcessOnKeyDown(KeyEventArgs)

Declaration
protected virtual void ProcessOnKeyDown(KeyEventArgs e)
Parameters
System.Windows.Forms.KeyEventArgs e

RefreshItems()

Declaration
protected virtual void RefreshItems()

SetItemCore(Int32, Object)

Declaration
protected virtual void SetItemCore(int index, object value)
Parameters
System.Int32 index

System.Object value

SetItemsCore(IList)

Declaration
protected virtual void SetItemsCore(IList items)
Parameters
System.Collections.IList items

Events

AnimationFinished

Declaration
public event EventHandler AnimationFinished
Event Type
System.EventHandler

AnimationStarted

Declaration
public event EventHandler AnimationStarted
Event Type
System.EventHandler

ItemDataBound

Occurs after an Item is databound.

Declaration
public event ItemDataBoundEventHandler ItemDataBound
Event Type
ItemDataBoundEventHandler

ItemEntering

Occurs when an Item is about to enter carousel view

Declaration
public event ItemEnteringEventHandler ItemEntering
Event Type
ItemEnteringEventHandler

ItemLeaving

Occurs when an Item is about to leave carousel view

Declaration
public event ItemLeavingEventHandler ItemLeaving
Event Type
ItemLeavingEventHandler

NewCarouselItemCreating

Occurs before a new databound carousel item is created. You can use this event to replace the default item.

Declaration
public event NewCarouselItemCreatingEventHandler NewCarouselItemCreating
Event Type
NewCarouselItemCreatingEventHandler

SelectedIndexChanged

Fires when the selected index is changed.

Declaration
public event EventHandler SelectedIndexChanged
Event Type
System.EventHandler

SelectedItemChanged

Occurs when the selected items is changed.

Declaration
public event EventHandler SelectedItemChanged
Event Type
System.EventHandler

SelectedValueChanged

Fires when the selected value is changed.

Declaration
public event EventHandler SelectedValueChanged
Event Type
System.EventHandler

Explicit Interface Implementations

IDisposable.Dispose()

Declaration
void IDisposable.Dispose()
Implements
System.IDisposable.Dispose()

Extension Methods