RadCarousel
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, IAnalyticsProviderInheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadCarousel...
Implements:
Inherited Members
Constructors
Initializes a new instance of the RadCarousel class.
public RadCarousel()Properties
Gets or sets the delay in ms. between two frames of animation.
[Browsable(true)]
public int AnimationDelay { get; set; }Gets or sets the number of animation frames between two positions.
[Browsable(true)]
public int AnimationFrames { get; set; }Gets or sets value indicating which of the predefined animations will be applied to carousel items
public Animations AnimationsToApply { get; set; }Gets or sets a value indicating whether carousel will increment or decrement item indexes when in auto-loop mode.
public AutoLoopDirections AutoLoopDirection { get; set; }Gets or sets a value indicating when carousel will pause looping if in auto-loop mode.
public AutoLoopPauseConditions AutoLoopPauseCondition { get; set; }Gets or sets a value indicating the interval (in seconds) after which the carousel will resume looping when in auto-loop mode.
public int AutoLoopPauseInterval { get; set; }Gets the Next button that is used to navigate to the next item.
public RadRepeatButtonElement ButtonNext { get; }Represent the Navigation buttons Positions
public virtual NavigationButtonsPosition ButtonPositions { get; set; }Gets the Previous button that is used to navigate to the previous item.
public RadRepeatButtonElement ButtonPrevious { get; }Gets a reference to the Carousel element, which encapsulates the most of the functionality of RadCarousel
public RadCarouselElement CarouselElement { get; }Gets or sets the path that carousel items will follow when animated.
[TypeConverter(typeof(CarouselPathConverter))]
public CarouselParameterPath CarouselPath { get; set; }Gets or sets the data source for the carousel items.
public object DataSource { get; set; }Gets the default size of the control.
protected override Size DefaultSize { get; }Overrides:
Gets or sets the easing equation to be used for the animations.
public RadEasingType EasingType { get; set; }Enable or disable the re-animation of RadCarousel on form maximize, minimize or resize
public virtual bool EnableAnimationOnFormResize { get; set; }Gets or sets a value indicating that the Carousel will loop items automatically.
public bool EnableAutoLoop { get; set; }Gets or sets a value indicating whether the keyboard navigation is enabled.
[Browsable(true)]
public virtual bool EnableKeyboardNavigation { get; set; }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.
[Browsable(false)]
public bool EnableLooping { get; set; }Gets or sets a value indicating whether relative point coordinates are used. If set to true, each point should be between 0 and 100.
public bool EnableRelativePath { get; set; }Gets or sets a value indicating whether formatting is applied to the DisplayMember property.
public bool FormattingEnabled { get; set; }Gets or sets the default action when item is clicked as CarouselItemClickAction member.
public CarouselItemClickAction ItemClickDefaultAction { get; set; }The item click default action.
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.
public double ItemReflectionPercentage { get; set; }The item reflection percentage.
0.0 indicates no reflection and 1.0 indicates 100% of the height of the original item
Gets the collection of items in the carousel.
[RadEditItemsAction]
public RadItemCollection Items { get; }Gets or sets value indicating the minimum value of the opacity applied to items
public double MinFadeOpacity { get; set; }Get or sets the minimum size to apply on an element when layout is calculated.
public virtual Size NavigationButtonsOffset { get; set; }Sets the way opacity is applied to carousel items
public OpacityChangeConditions OpacityChangeCondition { get; set; }Gets or sets the item in the carousel that is currently selected.
public virtual int SelectedIndex { get; set; }Gets or sets the currently selected item in the carousel.
public virtual object SelectedItem { get; set; }Gets or sets the value of the currently selected item in the carousel.
public object SelectedValue { get; set; }Gets or sets the field from the data source to use as the actual value for the carousel items.
public string ValueMember { get; set; }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.
public bool VirtualMode { get; set; }False indicates that all items be displayed. It depends on SelectedIndex, which items are displayed in this case.
Gets or sets the number of items that carousel displays when VirtualMode is set to true.
public int VisibleItemCount { get; set; }Methods
Determines whether the control defines the theme for the specified element.
public override bool ControlDefinesThemeForElement(RadElement element)The element to check.
Returns:true if the control defines the theme for the element; otherwise, false.
Overrides:
Creates the child elements for the RadCarousel control.
protected override void CreateChildItems(RadElement parent)The parent element to which the child elements will be added.
Overrides:
Gets the input element for keyboard navigation.
protected override RadElement GetInputElement()The RadCarouselElement that handles input.
Overrides:
Called when the control is loaded. Enables pan gesture support for the carousel.
protected override void OnLoad(Size desiredSize)The desired size for the control.
Overrides:
Events
Occurs after an Item is data-bound.
[Browsable(true)]
public event ItemDataBoundEventHandler ItemDataBoundOccurs before a new data-bound carousel item is created. You can use this event to replace the default item.
[Browsable(true)]
public event NewCarouselItemCreatingEventHandler NewCarouselItemCreatingOccurs when the SelectedIndex property has changed.
[Browsable(true)]
public event EventHandler SelectedIndexChangedOccurs when the selected item is changed.
[Browsable(true)]
public event EventHandler SelectedItemChangedOccurs when the SelectedValue property has changed.
[Browsable(true)]
public event EventHandler SelectedValueChanged