Class RadCarouselPanel

RadCarouselPanel is a specialized panel that arranges its children on a path.

Inheritance

System.Object

RadCarouselPanel

Namespace: Telerik.Windows.Controls

Assembly: Telerik.Windows.Controls.Navigation.dll

Syntax

[TelerikToolboxCategory("Navigation")]
public class RadCarouselPanel : VirtualizingPanel, IScrollInfo

Constructors

RadCarouselPanel()

Initializes a new instance of the RadCarouselPanel class.

Declaration

public RadCarouselPanel()

Fields

AutoLoadItemsProperty

Identifies the AutoLoadItems dependency property.

Declaration

public static readonly DependencyProperty AutoLoadItemsProperty

Field Value

System.Windows.DependencyProperty

IsAnimatingChangedEvent

Identifies the IsAnimatingChanged routed event.

Declaration

public static readonly RoutedEvent IsAnimatingChangedEvent

Field Value

System.Windows.RoutedEvent

IsAnimatingProperty

Identifies the IsAnimating dependency property.

Declaration

public static readonly DependencyProperty IsAnimatingProperty

Field Value

System.Windows.DependencyProperty

IsContinuousProperty

Gets or sets a value indicating whether items should wrap around after the last item is displayed.

Declaration

public static readonly DependencyProperty IsContinuousProperty

Field Value

System.Windows.DependencyProperty

IsOpacityEnabledProperty

Identifies the IsOpacityEnabled dependency property.

Declaration

public static readonly DependencyProperty IsOpacityEnabledProperty

Field Value

System.Windows.DependencyProperty

IsPathVisibleProperty

Identifies the IsPathVisible dependency property.

Declaration

public static readonly DependencyProperty IsPathVisibleProperty

Field Value

System.Windows.DependencyProperty

IsScalingEnabledProperty

Identifies the IsScalingEnabled dependency property.

Declaration

public static readonly DependencyProperty IsScalingEnabledProperty

Field Value

System.Windows.DependencyProperty

IsSelectedTopItemProperty

Identifies the IsSelectedTopItem dependency property.

Declaration

public static readonly DependencyProperty IsSelectedTopItemProperty

Field Value

System.Windows.DependencyProperty

IsSkewAngleXEnabledProperty

Identifies the IsSkewAngleXEnabled dependency property.

Declaration

public static readonly DependencyProperty IsSkewAngleXEnabledProperty

Field Value

System.Windows.DependencyProperty

IsSkewAngleYEnabledProperty

Identifies the IsSkewAngleYEnabled dependency property.

Declaration

public static readonly DependencyProperty IsSkewAngleYEnabledProperty

Field Value

System.Windows.DependencyProperty

ItemsMovementAnimationDurationProperty

Identifies the ItemsMovementAnimationDuration dependency property.

Declaration

public static readonly DependencyProperty ItemsMovementAnimationDurationProperty

Field Value

System.Windows.DependencyProperty

ItemsPerPageProperty

Identifies the ItemsPerPage dependency property.

Declaration

public static readonly DependencyProperty ItemsPerPageProperty

Field Value

System.Windows.DependencyProperty

ItemsPerSwipeProperty

Identifies the ItemsPerSwipe dependency property.

Declaration

public static readonly DependencyProperty ItemsPerSwipeProperty

Field Value

System.Windows.DependencyProperty

OpacityStopsProperty

Identifies the OpacityStops dependency property.

Declaration

public static readonly DependencyProperty OpacityStopsProperty

Field Value

System.Windows.DependencyProperty

PathPaddingProperty

Identifies the PathPadding dependency property.

Declaration

public static readonly DependencyProperty PathPaddingProperty

Field Value

System.Windows.DependencyProperty

ScaleStopsProperty

Identifies the ScaleStops dependency property.

Declaration

public static readonly DependencyProperty ScaleStopsProperty

Field Value

System.Windows.DependencyProperty

SelectedIsTopItemEvent

Identifies the SelectedIsTopItem routed event.

Declaration

public static readonly RoutedEvent SelectedIsTopItemEvent

Field Value

System.Windows.RoutedEvent

SkewAngleXStopsProperty

Identifies the SkewAngleXStops dependency property.

Declaration

public static readonly DependencyProperty SkewAngleXStopsProperty

Field Value

System.Windows.DependencyProperty

SkewAngleYStopsProperty

Identifies the SkewAngleYStops dependency property.

Declaration

public static readonly DependencyProperty SkewAngleYStopsProperty

Field Value

System.Windows.DependencyProperty

TopContainerChangedEvent

Identifies the TopContainerChanged routed event.

Declaration

public static readonly RoutedEvent TopContainerChangedEvent

Field Value

System.Windows.RoutedEvent

TopContainerProperty

Identifies the TopContainer dependency property.

Declaration

public static readonly DependencyProperty TopContainerProperty

Field Value

System.Windows.DependencyProperty

TopItemPathFractionProperty

Identifies the TopItemPathFraction dependency property.

Declaration

public static readonly DependencyProperty TopItemPathFractionProperty

Field Value

System.Windows.DependencyProperty

Properties

AutoLoadItems

Gets or sets a value that indicates whether items will be loaded automatically when the carousel is shown.

Declaration

public bool AutoLoadItems { get; set; }

Property Value

System.Boolean

CanHorizontallyScroll

Gets or sets a value that indicates whether scrolling on the horizontal axis is possible.

Declaration

public bool CanHorizontallyScroll { get; set; }

Property Value

System.Boolean true if scrolling is possible; otherwise, false. This property has no default value.

CanVerticallyScroll

Gets or sets a value that indicates whether scrolling on the vertical axis is possible.

Declaration

public bool CanVerticallyScroll { get; set; }

Property Value

System.Boolean true if scrolling is possible; otherwise, false. This property has no default value.

ExtentHeight

Gets the vertical size of the extent.

Declaration

public double ExtentHeight { get; }

Property Value

System.Double

ExtentWidth

Gets the horizontal size of the extent.

Declaration

public double ExtentWidth { get; }

Property Value

System.Double

HorizontalOffset

Gets the horizontal offset of the scrolled content.

Declaration

public double HorizontalOffset { get; }

Property Value

System.Double

IsAnimating

Gets a value indicating whether the panel is currently animating.

Declaration

public bool IsAnimating { get; }

Property Value

System.Boolean `true` if the panel is animating; otherwise, `false`.

IsContinuous

Gets or sets a value indicating whether items should wrap around after the last item is displayed.

Declaration

public bool IsContinuous { get; set; }

Property Value

System.Boolean `true` Items should wrap around; otherwise, `false`.

IsOpacityEnabled

Gets or sets a value indicating whether opacity effect is enabled.

Declaration

public bool IsOpacityEnabled { get; set; }

Property Value

System.Boolean `true` if opacity effect is enabled; otherwise, `false`.

IsPathVisible

Gets or sets a value that indicates whether the carousel path is visible.

Declaration

public bool IsPathVisible { get; set; }

Property Value

System.Boolean

IsScalingEnabled

Gets or sets a value indicating whether scale effect is enabled.

Declaration

public bool IsScalingEnabled { get; set; }

Property Value

System.Boolean `true` if scale effect is enabled; otherwise, `false`.

IsSelectedTopItem

Gets a value indicating whether the selected items has been brought into view.

Declaration

public bool IsSelectedTopItem { get; set; }

Property Value

System.Boolean `true` if this the selected item's path fraction matches the TopItemPathFractionProperty; otherwise, `false`.

IsSkewAngleXEnabled

Gets or sets a value indicating whether this instance is skew angle X enabled.

Declaration

public bool IsSkewAngleXEnabled { get; set; }

Property Value

System.Boolean `true` if this instance is skew angle X enabled; otherwise, `false`.

IsSkewAngleYEnabled

Gets or sets a value indicating whether this instance is skew angle Y enabled.

Declaration

public bool IsSkewAngleYEnabled { get; set; }

Property Value

System.Boolean `true` if this instance is skew angle Y enabled; otherwise, `false`.

ItemsMovementAnimationDuration

Gets or sets the duration of the item movement animation.

Declaration

public TimeSpan ItemsMovementAnimationDuration { get; set; }

Property Value

System.TimeSpan

ItemsPerPage

Gets or sets the number of items per page.

Declaration

public int ItemsPerPage { get; set; }

Property Value

System.Int32

ItemsPerSwipe

Gets or sets the number of items to be scrolled per swipe gesture.

Declaration

public int ItemsPerSwipe { get; set; }

Property Value

System.Int32

OpacityStops

Gets or sets the opacity stops.

Declaration

public PathStopCollection OpacityStops { get; set; }

Property Value

PathStopCollection The opacity stops.

Path

Gets or sets the carousel path.

Declaration

public Path Path { get; set; }

Property Value

System.Windows.Shapes.Path

PathPadding

Gets or sets the path padding property.

Declaration

public Thickness PathPadding { get; set; }

Property Value

System.Windows.Thickness The path padding.

ScaleStops

Gets or sets the scale stops.

Declaration

public PathStopCollection ScaleStops { get; set; }

Property Value

PathStopCollection The scale stops.

ScrollOwner

Gets or sets a System.Windows.Controls.ScrollViewer element that controls scrolling behavior.

Declaration

public ScrollViewer ScrollOwner { get; set; }

Property Value

System.Windows.Controls.ScrollViewer A System.Windows.Controls.ScrollViewer element that controls scrolling behavior. This property has no default value.

SkewAngleXStops

Gets or sets the skew angle X stops.

Declaration

public PathStopCollection SkewAngleXStops { get; set; }

Property Value

PathStopCollection The skew angle X stops.

SkewAngleYStops

Gets or sets the skew angle Y stops.

Declaration

public PathStopCollection SkewAngleYStops { get; set; }

Property Value

PathStopCollection The skew angle Y stops.

TopContainer

Gets the container that has the largest ZIndex.

Declaration

public UIElement TopContainer { get; }

Property Value

System.Windows.UIElement The top container.

TopItemPathFraction

Gets or sets the top item path fraction.

Declaration

public double TopItemPathFraction { get; set; }

Property Value

System.Double The top item path fraction.

VerticalOffset

Gets the vertical offset of the scrolled content.

Declaration

public double VerticalOffset { get; }

Property Value

System.Double A System.Double that represents, in device independent pixels, the vertical offset of the scrolled content. Valid values are between zero and the System.Windows.Controls.Primitives.IScrollInfo.ExtentHeight minus the System.Windows.Controls.Primitives.IScrollInfo.ViewportHeight. This property has no default value.

ViewportHeight

Gets the vertical size of the viewport for this content.

Declaration

public double ViewportHeight { get; }

Property Value

System.Double A System.Double that represents, in device independent pixels, the vertical size of the viewport for this content. This property has no default value.

ViewportWidth

Gets the horizontal size of the viewport for this content.

Declaration

public double ViewportWidth { get; }

Property Value

System.Double A System.Double that represents, in device independent pixels, the vertical size of the viewport for this content. This property has no default value.

Methods

ArrangeOverride(Size)

When overridden in a derived class, positions child elements and determines a size for a FrameworkElement derived class.

Declaration

protected override Size ArrangeOverride(Size finalSize)

Parameters

System.Windows.Size finalSize The final area within the parent that this element should use to arrange itself and its children.

Returns

System.Windows.Size The actual size used.

BringDataItemIntoView(Object)

Brings the specified data item into view.

Declaration

public void BringDataItemIntoView(object dataItem)

Parameters

System.Object dataItem The data item to bring into view.

BringIndexIntoView(Int32)

When implemented in a derived class, generates the item at the specified index location and makes it visible.

Declaration

protected override void BringIndexIntoView(int index)

Parameters

System.Int32 index The index position of the item that is generated and made visible.

BringItemIntoView(UIElement, Boolean)

Brings the specified item into view.

Declaration

public void BringItemIntoView(UIElement item, bool isItemSelected)

Parameters

System.Windows.UIElement item The item to bring into view.
System.Boolean isItemSelected Determines whether the item is currently selected.

ClearSelectedItem()

Clears the item that RadCarouselPanel considers as selected.

Declaration

public void ClearSelectedItem()

CreateUIElementCollection(FrameworkElement)

Overrides the default System.Windows.Controls.UIElementCollection .

Declaration

protected override UIElementCollection CreateUIElementCollection(FrameworkElement logicalParent)

Parameters

System.Windows.FrameworkElement logicalParent The logical parent element of the collection to be created.

Returns

System.Windows.Controls.UIElementCollection An ordered collection of elements that have the specified logical parent.

LineDown()

Scrolls down within content by one logical unit.

Declaration

public void LineDown()

LineLeft()

Scrolls left within content by one logical unit.

Declaration

public void LineLeft()

LineRight()

Scrolls right within content by one logical unit.

Declaration

public void LineRight()

LineUp()

Scrolls up within content by one logical unit.

Declaration

public void LineUp()

MakeVisible(Visual, Rect)

Forces content to scroll until the coordinate space of a System.Windows.Media.Visual object is visible.

Declaration

public Rect MakeVisible(Visual visual, Rect rectangle)

Parameters

System.Windows.Media.Visual visual A System.Windows.Media.Visual that becomes visible.
System.Windows.Rect rectangle A bounding rectangle that identifies the coordinate space to make visible.

Returns

System.Windows.Rect A System.Windows.Rect that is visible.

MeasureOverride(Size)

When overridden in a derived class, measures the size in layout required for child elements and determines a size for the FrameworkElement-derived class.

Declaration

protected override Size MeasureOverride(Size availableSize)

Parameters

System.Windows.Size availableSize The available size that this element can give to child elements. Infinity can be specified as a value to indicate that the element will size to whatever content is available.

Returns

System.Windows.Size The size that this element determines it needs during layout, based on its calculations of child element sizes.

MouseWheelDown()

Scrolls down within content after a user clicks the wheel button on a mouse.

Declaration

public void MouseWheelDown()

MouseWheelLeft()

Scrolls left within content after a user clicks the wheel button on a mouse.

Declaration

public void MouseWheelLeft()

MouseWheelRight()

Scrolls right within content after a user clicks the wheel button on a mouse.

Declaration

public void MouseWheelRight()

MouseWheelUp()

Scrolls up within content after a user clicks the wheel button on a mouse.

Declaration

public void MouseWheelUp()

MoveBy(Int32)

Moves by a specified number of items.

Declaration

public void MoveBy(int displacement)

Parameters

System.Int32 displacement The number of items to move by. Positive value will move the items forward, while negative one will move the items backwards.

OnIsAnimatingChanged(Boolean, Boolean)

Called when IsAnimating property is changed.

Declaration

protected virtual void OnIsAnimatingChanged(bool oldValue, bool newValue)

Parameters

System.Boolean oldValue If set to `true` [old value].
System.Boolean newValue If set to `true` [new value].

OnIsItemsHostChanged(Boolean, Boolean)

Indicates that the System.Windows.Controls.Panel.IsItemsHost property value has changed.

Declaration

protected override void OnIsItemsHostChanged(bool oldIsItemsHost, bool newIsItemsHost)

Parameters

System.Boolean oldIsItemsHost The old property value.
System.Boolean newIsItemsHost The new property value.

OnItemsChanged(Object, ItemsChangedEventArgs)

Called when the System.Windows.Controls.ItemsControl.Items collection that is associated with the System.Windows.Controls.ItemsControl for this System.Windows.Controls.Panel changes.

Declaration

protected override void OnItemsChanged(object sender, ItemsChangedEventArgs args)

Parameters

System.Object sender The System.Object that raised the event.
System.Windows.Controls.Primitives.ItemsChangedEventArgs args Provides data for the System.Windows.Controls.ItemContainerGenerator.ItemsChanged event.

OnRender(DrawingContext)

Draws the content of a System.Windows.Media.DrawingContext object during the render pass of a System.Windows.Controls.Panel element.

Declaration

protected override void OnRender(DrawingContext dc)

Parameters

System.Windows.Media.DrawingContext dc The System.Windows.Media.DrawingContext object to draw.

OnTopContainerChanged(UIElement, UIElement)

Called when TopContainer property is changed.

Declaration

protected virtual void OnTopContainerChanged(UIElement oldValue, UIElement newValue)

Parameters

System.Windows.UIElement oldValue The old value.
System.Windows.UIElement newValue The new value.

PageDown()

Scrolls down within content by one page.

Declaration

public void PageDown()

PageLeft()

Scrolls left within content by one page.

Declaration

public void PageLeft()

PageRight()

Scrolls right within content by one page.

Declaration

public void PageRight()

PageUp()

Scrolls up within content by one page.

Declaration

public void PageUp()

SetHorizontalOffset(Double)

Sets the amount of horizontal offset.

Declaration

public void SetHorizontalOffset(double offset)

Parameters

System.Double offset The degree to which content is horizontally offset from the containing viewport.

SetVerticalOffset(Double)

Sets the amount of vertical offset.

Declaration

public void SetVerticalOffset(double offset)

Parameters

System.Double offset The degree to which content is vertically offset from the containing viewport.

Events

IsAnimatingChanged

Occurs when IsAnimating property is changed.

Declaration

public event RoutedEventHandler IsAnimatingChanged

Event Type

System.Windows.RoutedEventHandler

SelectedIsTopItem

Occurs when [selected is top item].

Declaration

public event RoutedEventHandler SelectedIsTopItem

Event Type

System.Windows.RoutedEventHandler

TopContainerChanged

Occurs when TopContainer property is changed.

Declaration

public event RoutedEventHandler TopContainerChanged

Event Type

System.Windows.RoutedEventHandler

Extension Methods

CollectionExtensions.ToEnumerable<T>(T)

EnumerableExtensions.ToEnumerable<T>(T)