ClassRadCarousel
Represents a carousel control that animates a group of items in a carousel-style rotation with customizable paths and animations.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
[Docking(DockingBehavior.Ask)]
public class RadCarousel : RadControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProvider
Inheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadCarousel
Implements:
Inherited Members
Constructors
RadCarousel()
Initializes a new instance of the RadCarousel class.
Declaration
public RadCarousel()
Properties
AnimationDelay
Gets or sets the delay in ms. between two frames of animation.
Declaration
[Browsable(true)]
public int AnimationDelay { get; set; }
Property Value
AnimationFrames
Gets or sets the number of animation frames between two positions.
Declaration
[Browsable(true)]
public int AnimationFrames { get; set; }
Property Value
AnimationsToApply
Gets or sets value indicating which of the predefined animations will be applied to carousel items
Declaration
public Animations AnimationsToApply { get; set; }
Property Value
AutoLoopDirection
Gets or sets a value indicating whether carousel will increment or decrement item indexes when in auto-loop mode.
Declaration
public AutoLoopDirections AutoLoopDirection { get; set; }
Property Value
AutoLoopPauseCondition
Gets or sets a value indicating when carousel will pause looping if in auto-loop mode.
Declaration
public AutoLoopPauseConditions AutoLoopPauseCondition { get; set; }
Property Value
AutoLoopPauseInterval
Gets or sets a value indicating the interval (in seconds) after which the carousel will resume looping when in auto-loop mode.
ButtonNext
Gets the Next button that is used to navigate to the next item.
Declaration
public RadRepeatButtonElement ButtonNext { get; }
Property Value
ButtonPositions
Represent the Navigation buttons Positions
Declaration
public virtual NavigationButtonsPosition ButtonPositions { get; set; }
Property Value
ButtonPrevious
Gets the Previous button that is used to navigate to the previous item.
Declaration
public RadRepeatButtonElement ButtonPrevious { get; }
Property Value
CarouselElement
Gets a reference to the Carousel element, which encapsulates the most of the functionality of RadCarousel
Declaration
public RadCarouselElement CarouselElement { get; }
Property Value
CarouselPath
Gets or sets the path that carousel items will follow when animated.
Declaration
[TypeConverter(typeof(CarouselPathConverter))]
public CarouselParameterPath CarouselPath { get; set; }
Property Value
DataSource
Gets or sets the data source for the carousel items.
DefaultSize
Gets the default size of the control.
Declaration
protected override Size DefaultSize { get; }
Property Value
Overrides
EasingType
Gets or sets the easing equation to be used for the animations.
Declaration
public RadEasingType EasingType { get; set; }
Property Value
EnableAnimationOnFormResize
Enable or disable the re-animation of RadCarousel on form maximize, minimize or resize
Declaration
public virtual bool EnableAnimationOnFormResize { get; set; }
Property Value
EnableAutoLoop
Gets or sets a value indicating that the Carousel will loop items automatically.
EnableKeyboardNavigation
Gets or sets a value indicating whether the keyboard navigation is enabled.
Declaration
[Browsable(true)]
public virtual bool EnableKeyboardNavigation { get; set; }
Property Value
EnableLooping
Gets or sets value indicating that when item position goes beyond the carousel path, it will be displayed again in the beginning of the carousel path.
Declaration
[Browsable(false)]
public bool EnableLooping { get; set; }
Property Value
EnableRelativePath
Gets or sets a value indicating whether relative point coordinates are used. If set to true, each point should be between 0 and 100.
FormattingEnabled
Gets or sets a value indicating whether formatting is applied to the DisplayMember property.
ItemClickDefaultAction
Gets or sets the default action when item is clicked as CarouselItemClickAction member.
Declaration
public CarouselItemClickAction ItemClickDefaultAction { get; set; }
Property Value
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
The item reflection percentage.
Remarks
0.0 indicates no reflection and 1.0 indicates 100% of the height of the original item
Items
Gets the collection of items in the carousel.
Declaration
[RadEditItemsAction]
public RadItemCollection Items { get; }
Property Value
MinFadeOpacity
Gets or sets value indicating the minimum value of the opacity applied to items
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
OpacityChangeCondition
Sets the way opacity is applied to carousel items
Declaration
public OpacityChangeConditions OpacityChangeCondition { get; set; }
Property Value
SelectedIndex
Gets or sets the item in the carousel that is currently selected.
SelectedItem
Gets or sets the currently selected item in the carousel.
Declaration
public virtual object SelectedItem { get; set; }
Property Value
SelectedValue
Gets or sets the value of the currently selected item in the carousel.
ValueMember
Gets or sets the field from the data source to use as the actual value for the carousel items.
VirtualMode
Get or sets value indicating the maximum number of items that will be displayed in the carousel, even when there are more Items in the Items collection. Virtualizing the carousel would significantly improve its performance.
Declaration
public bool VirtualMode { get; set; }
Property Value
Remarks
False indicates that all items be displayed. It depends on SelectedIndex, which items are displayed in this case.
VisibleItemCount
Gets or sets the number of items that carousel displays when VirtualMode is set to true.
Methods
ControlDefinesThemeForElement(RadElement)
Determines whether the control defines the theme for the specified element.
Declaration
public override bool ControlDefinesThemeForElement(RadElement element)
Parameters
element
The element to check.
Returns
true if the control defines the theme for the element; otherwise, false.
Overrides
CreateChildItems(RadElement)
Creates the child elements for the RadCarousel control.
Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
parent
The parent element to which the child elements will be added.
Overrides
GetInputElement()
Gets the input element for keyboard navigation.
Declaration
protected override RadElement GetInputElement()
Returns
The RadCarouselElement that handles input.
Overrides
OnLoad(Size)
Called when the control is loaded. Enables pan gesture support for the carousel.
Declaration
protected override void OnLoad(Size desiredSize)
Parameters
desiredSize
The desired size for the control.
Overrides
Events
ItemDataBound
Occurs after an Item is data-bound.
Declaration
[Browsable(true)]
public event ItemDataBoundEventHandler ItemDataBound
Event Value
NewCarouselItemCreating
Occurs before a new data-bound carousel item is created. You can use this event to replace the default item.
Declaration
[Browsable(true)]
public event NewCarouselItemCreatingEventHandler NewCarouselItemCreating
Event Value
SelectedIndexChanged
Occurs when the SelectedIndex property has changed.
Declaration
[Browsable(true)]
public event EventHandler SelectedIndexChanged
Event Value
SelectedItemChanged
Occurs when the selected item is changed.
Declaration
[Browsable(true)]
public event EventHandler SelectedItemChanged
Event Value
SelectedValueChanged
Occurs when the SelectedValue property has changed.
Declaration
[Browsable(true)]
public event EventHandler SelectedValueChanged
Event Value