Class

RadCarouselElement

Declaration

public RadCarouselElement()

Gets or sets the delay in milliseconds between animation frames during carousel transitions.

Declaration

[Browsable(false)]
public int AnimationDelay { get; set; }

Property Value

Gets or sets the number of animation frames used during carousel transitions.

Declaration

[Browsable(false)]
public int AnimationFrames { get; set; }

Property Value

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

Gets the next navigation button element used to navigate to the next carousel item.

Declaration

[Browsable(false)]
public RadRepeatButtonElement ButtonNext { get; }

Property Value

Gets or sets the position of the navigation buttons within the carousel element.

Declaration

[Browsable(false)]
public virtual NavigationButtonsPosition ButtonPositions { get; set; }

Property Value

Gets the previous navigation button element used to navigate to the previous carousel item.

Declaration

[Browsable(false)]
public RadRepeatButtonElement ButtonPrevious { get; }

Property Value

Declaration

public CarouselItemsContainer CarouselItemContainer { get; }

Property Value

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

Declaration

[Browsable(true)]
public bool CaseSensitive { get; set; }

Property Value

Gets the currency manager that provides data management functionality for data binding.

Declaration

protected virtual CurrencyManager DataManager { get; }

Property Value

Gets or sets the data source that provides data for the carousel items.

Declaration

[Browsable(false)]
public object DataSource { get; set; }

Property Value

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

Declaration

[Browsable(true)]
public bool EnableKeyboardNavigation { get; set; }

Property Value

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

Declaration

[Browsable(false)]
public bool FormattingEnabled { get; set; }

Property Value

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

Declaration

[Browsable(false)]
public CarouselItemClickAction ItemClickDefaultAction { get; set; }

Property Value

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

[Browsable(false)]
public double ItemReflectionPercentage { get; set; }

Property Value

Remarks

Gets a collection of RadItem objects managed by RadCarousel.

Declaration

public RadItemCollection Items { get; }

Property Value

Remarks

Gets the element, which contains all visible carousel items

Declaration

public CarouselItemsContainer ItemsContainer { get; }

Property Value

Gets or sets the offset for positioning the navigation buttons relative to their default positions.

Declaration

[Browsable(false)]
public virtual Size NavigationButtonsOffset { get; set; }

Property Value

Gets or sets the zero-based index of the currently selected item in the carousel.

Declaration

[Browsable(false)]
public virtual int SelectedIndex { get; set; }

Property Value

Gets or sets the currently selected item in the carousel.

Declaration

[Browsable(false)]
[Bindable(true)]
public virtual object SelectedItem { get; set; }

Property Value

Gets or sets the value of the currently selected item in the carousel, based on the ValueMember property.

Declaration

[Browsable(false)]
[Bindable(true)]
public object SelectedValue { get; set; }

Property Value

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

Declaration

[Browsable(false)]
public string ValueMember { get; set; }

Property Value

Arranges the child elements within the final layout size, positioning the navigation buttons according to their configured position.

Declaration

protected override SizeF ArrangeOverride(SizeF finalSize)

Parameters

Returns

Overrides RadElement.ArrangeOverride(SizeF)

Suspends layout updates for the carousel to improve performance during bulk operations.

Declaration

public void BeginUpdate()

Creates and initializes the child elements including background, border, carousel container, and navigation buttons.

Declaration

protected override void CreateChildElements()

Overrides RadElement.CreateChildElements()

Creates a new carousel item instance and allows customization through the NewCarouselItemCreating event.

Declaration

protected virtual RadItem CreateNewCarouselItem()

Returns

Handles complete refresh of items when the data manager notifies of changes.

Declaration

protected virtual void DataManagerItemChanged()

Handles item changes in the data manager when data binding is used.

Declaration

protected virtual void DataManagerItemChanged(object sender, ItemChangedEventArgs e)

Parameters

Handles position changes in the data manager when data binding is used.

Declaration

protected virtual void DataManagerPositionChanged(object sender, EventArgs e)

Parameters

Resumes layout updates for the carousel after a BeginUpdate() call.

Declaration

public void EndUpdate()

Finds the first item in the carousel with text containing the specified substring.

Declaration

public RadItem FindItemContaining(string subString)

Parameters

Returns

Finds the first item in the carousel that matches the specified text exactly.

Declaration

public RadItem FindItemExact(string text)

Parameters

Returns

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

Declaration

public RadItem FindItemStartingWith(string startsWith)

Parameters

Returns

Gets the value of the specified item using the ValueMember property.

Declaration

public virtual object GetItemValue(object item)

Parameters

Returns

Initializes the internal fields and sets up the default behavior for the carousel element.

Declaration

protected override void InitializeFields()

Overrides RadItem.InitializeFields()

Determines whether the specified key is an input key for the carousel navigation.

Declaration

protected override bool IsInputKey(InputKeyEventArgs e)

Parameters

Returns

Overrides RadElement.IsInputKey(InputKeyEventArgs)

Called when a carousel animation finishes and handles auto-loop continuation logic.

Declaration

public virtual void OnAnimationFinished()

Called when a carousel animation starts and raises the AnimationStarted event.

Declaration

public virtual void OnAnimationStarted()

Raises the ItemDataBound event.

Declaration

protected virtual void OnItemDataBound(ItemDataBoundEventArgs e)

Parameters

Fires the ItemEntering event

Declaration

protected void OnItemEntering(ItemEnteringEventArgs args)

Parameters

Fires the ItemLeaving event

Declaration

protected void OnItemLeaving(ItemLeavingEventArgs args)

Parameters

Called when the element is loaded and triggers the initial selection events.

Declaration

protected override void OnLoaded()

Overrides RadElement.OnLoaded()

Raises the CreateNewCarouselItem event.

Declaration

protected virtual void OnNewCarouselItemCreating(NewCarouselItemCreatingEventArgs e)

Parameters

Handles property change notifications and performs appropriate actions based on the changed property.

Declaration

protected override void OnNotifyPropertyChanged(string propertyName)

Parameters

Overrides RadObject.OnNotifyPropertyChanged(string)

Handles pan gesture events for touch-based carousel navigation.

Declaration

protected override void OnPanGesture(PanGestureEventArgs args)

Parameters

Overrides RadItem.OnPanGesture(PanGestureEventArgs)

Called when a property value changes and handles specific property change logic.

Declaration

protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)

Parameters

Overrides RadItem.OnPropertyChanged(RadPropertyChangedEventArgs)

Raises the SelectedIndexChanged event.

Declaration

protected virtual void OnSelectedIndexChanged(SelectedIndexChangedEventArgs e)

Parameters

Raises the SelectedItemChanged event.

Declaration

protected virtual void OnSelectedItemChanged(EventArgs e)

Parameters

Raises the SelectedValueChanged event.

Declaration

protected virtual void OnSelectedValueChanged(EventArgs e)

Parameters

Processes keyboard input for carousel navigation when keyboard navigation is enabled.

Declaration

protected virtual void ProcessOnKeyDown(KeyEventArgs e)

Parameters

Refreshes the carousel items from the current data source.

Declaration

protected virtual void RefreshItems()

Sets the item at the specified index with the provided data value.

Declaration

protected virtual void SetItemCore(int index, object value)

Parameters

Sets the core items collection from the provided list of data items.

Declaration

protected virtual void SetItemsCore(IList items)

Parameters

Occurs when carousel animation finishes.

Declaration

public event EventHandler AnimationFinished

Event Value

Occurs when carousel animation starts.

Declaration

public event EventHandler AnimationStarted

Event Value

Occurs after an Item is data-bound.

Declaration

[Browsable(false)]
public event ItemDataBoundEventHandler ItemDataBound

Event Value

Occurs when an Item is about to enter carousel view

Declaration

public event ItemEnteringEventHandler ItemEntering

Event Value

Occurs when an Item is about to leave carousel view

Declaration

public event ItemLeavingEventHandler ItemLeaving

Event Value

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

Declaration

[Browsable(false)]
public event NewCarouselItemCreatingEventHandler NewCarouselItemCreating

Event Value

Occurs when the SelectedIndex property has changed.

Declaration

[Browsable(true)]
public event EventHandler SelectedIndexChanged

Event Value

Occurs when the selected item is changed.

Declaration

[Browsable(false)]
public event EventHandler SelectedItemChanged

Event Value

Occurs when the SelectedValue property has changed.

Declaration

[Browsable(true)]
public event EventHandler SelectedValueChanged

Event Value