Carousel Class
Definition
An items control that displays its items as pages and can reveal adjacent pages using Avalonia.Controls.Carousel.ViewportFraction.
public class Carousel
Constructors
| Name | Description |
|---|---|
| Carousel | No summary available. |
Carousel Constructor
public Carousel()
Methods
| Name | Description |
|---|---|
| AddHandler (2 overloads) | Adds a handler for the specified routed event. Inherited from Interactive. |
| ApplyStyling | Applies styling to the control if the control is initialized and styling is not already applied. Inherited from StyledElement. |
| ApplyTemplate | Creates the visual children of the control, if necessary Inherited from TemplatedControl. |
| Arrange | Arranges the control and its children. Inherited from Layoutable. |
| BeginInit | Inherited from SelectingItemsControl. |
| Bind (8 overloads) | Binds a Avalonia.AvaloniaProperty to an Avalonia.Data.BindingBase. Inherited from AvaloniaObject. |
| CheckAccess | Returns a value indicating whether the current thread is the UI thread. Inherited from AvaloniaObject. |
| ClearValue (4 overloads) | Clears a Avalonia.AvaloniaProperty's local value. Inherited from AvaloniaObject. |
| CoerceValue | Coerces the specified Avalonia.AvaloniaProperty. Inherited from AvaloniaObject. |
| ContainerFromIndex | Returns the container for the item at the specified index. Inherited from ItemsControl. |
| ContainerFromItem | Returns the container corresponding to the specified item. Inherited from ItemsControl. |
| EndInit | Inherited from SelectingItemsControl. |
| Equals | Compares two objects using reference equality. Inherited from AvaloniaObject. |
| Focus | Focuses the control. Inherited from InputElement. |
| GetBaseValue | Inherited from AvaloniaObject. |
| GetFlowDirection | Gets the value of the attached Avalonia.Visual.FlowDirectionProperty on a control. Inherited from Visual. |
| GetHashCode | Gets the hash code for the object. Inherited from AvaloniaObject. |
| GetIsHoldingEnabled | Inherited from InputElement. |
| GetIsHoldWithMouseEnabled | Inherited from InputElement. |
| GetIsSelected | Gets the value of the Avalonia.Controls.Primitives.SelectingItemsControl.IsSelectedProperty on the specified control. Inherited from SelectingItemsControl. |
| GetIsTemplateFocusTarget | Gets the value of the IsTemplateFocusTargetProperty attached property on a control. Inherited from TemplatedControl. |
| GetRealizedContainers | Gets the currently realized containers. Inherited from ItemsControl. |
| GetValue (3 overloads) | Gets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject. |
| IndexFromContainer | Returns the index to the item that has the specified, generated container. Inherited from ItemsControl. |
| InvalidateArrange | Invalidates the arrangement of the control and queues a new layout pass. Inherited from Layoutable. |
| InvalidateMeasure | Invalidates the measurement of the control and queues a new layout pass. Inherited from Layoutable. |
| InvalidateVisual | Invalidates the visual and queues a repaint. Inherited from Visual. |
| IsAnimating | Checks whether a Avalonia.AvaloniaProperty is animating. Inherited from AvaloniaObject. |
| IsSet | Checks whether a Avalonia.AvaloniaProperty is set on this object. Inherited from AvaloniaObject. |
| ItemFromContainer | Returns the item that corresponds to the specified, generated container. Inherited from ItemsControl. |
| ItemsControlFromItemContainer | Returns the Avalonia.Controls.ItemsControl that owns the specified container control. Inherited from SelectingItemsControl. |
| Measure | Carries out a measure of the control. Inherited from Layoutable. |
| Next | Moves to the next item in the carousel. |
| Previous | Moves to the previous item in the carousel. |
| RaiseEvent | Raises a routed event. Inherited from Interactive. |
| RemoveHandler (2 overloads) | Removes a handler for the specified routed event. Inherited from Interactive. |
| Render | Renders the visual to a Avalonia.Media.DrawingContext. Inherited from Visual. |
| ScrollIntoView (2 overloads) | Scrolls the specified item into view. Inherited from ItemsControl. |
| SetCurrentValue (2 overloads) | Sets the value of a dependency property without changing its value source. Inherited from AvaloniaObject. |
| SetFlowDirection | Sets the value of the attached Avalonia.Visual.FlowDirectionProperty on a control. Inherited from Visual. |
| SetIsHoldingEnabled | Inherited from InputElement. |
| SetIsHoldWithMouseEnabled | Inherited from InputElement. |
| SetIsSelected | Gets the value of the Avalonia.Controls.Primitives.SelectingItemsControl.IsSelectedProperty on the specified control. Inherited from SelectingItemsControl. |
| SetIsTemplateFocusTarget | Sets the value of the IsTemplateFocusTargetProperty attached property on a control. Inherited from TemplatedControl. |
| SetValue (3 overloads) | Sets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject. |
| TryGetResource | Inherited from StyledElement. |
| UpdateLayout | Executes a layout pass. Inherited from Layoutable. |
| UpdateSelectionFromEvent | Updates the selection based on an event that may have originated in a container that belongs to the control. Inherited from SelectingItemsControl. |
| VerifyAccess | Checks that the current thread is the UI thread and throws if not. Inherited from AvaloniaObject. |
Next Method
Moves to the next item in the carousel.
public void Next()
Previous Method
Moves to the previous item in the carousel.
public void Previous()
Properties
| Name | Description |
|---|---|
| ActualThemeVariant | Gets the UI theme that is currently used by the element, which might be different than the RequestedThemeVariantProperty. Inherited from StyledElement. |
| AutoScrollToSelectedItem | Gets or sets a value indicating whether to automatically scroll to newly selected items. Inherited from SelectingItemsControl. |
| Background | Gets or sets the brush used to draw the control's background. Inherited from TemplatedControl. |
| BackgroundSizing | Gets or sets how the control's background is drawn relative to the control's border. Inherited from TemplatedControl. |
| BorderBrush | Gets or sets the brush used to draw the control's border. Inherited from TemplatedControl. |
| BorderThickness | Gets or sets the thickness of the control's border. Inherited from TemplatedControl. |
| Bounds | Gets the bounds of the control relative to its parent. Inherited from Visual. |
| CacheMode | Gets or sets the cache mode of the visual. Inherited from Visual. |
| Classes | Gets or sets the styled element's classes. Inherited from StyledElement. |
| Clip | Gets or sets the geometry clip for this visual. Inherited from Visual. |
| ClipToBounds | Gets or sets a value indicating whether the control should be clipped to its bounds. Inherited from Visual. |
| ContextFlyout | Gets or sets a context flyout to the control Inherited from Control. |
| ContextMenu | Gets or sets a context menu to the control. Inherited from Control. |
| CornerRadius | Gets or sets the radius of the border rounded corners. Inherited from TemplatedControl. |
| Cursor | Gets or sets associated mouse cursor. Inherited from InputElement. |
| DataContext | Gets or sets the control's data context. Inherited from StyledElement. |
| DataTemplates | Gets or sets the data templates for the control. Inherited from Control. |
| DesiredSize | Gets the size that this element computed during the measure pass of the layout process. Inherited from Layoutable. |
| Dispatcher | Returns the Avalonia.AvaloniaObject.Dispatcher that this Avalonia.AvaloniaObject is associated with. Inherited from AvaloniaObject. |
| DisplayMemberBinding | Gets or sets the Avalonia.Data.BindingBase to use for binding to the display member of each item. Inherited from ItemsControl. |
| Effect | Gets or sets the effect of the control. Inherited from Visual. |
| FlowDirection | Gets or sets the text flow direction. Inherited from Visual. |
| Focusable | Gets or sets a value indicating whether the control can receive focus. Inherited from InputElement. |
| FocusAdorner | Gets or sets the control's focus adorner. Inherited from Control. |
| FontFamily | Gets or sets the font family used to draw the control's text. Inherited from TemplatedControl. |
| FontFeatures | Gets or sets the font features turned on/off. Inherited from TemplatedControl. |
| FontSize | Gets or sets the size of the control's text in points. Inherited from TemplatedControl. |
| FontStretch | Gets or sets the font stretch used to draw the control's text. Inherited from TemplatedControl. |
| FontStyle | Gets or sets the font style used to draw the control's text. Inherited from TemplatedControl. |
| FontWeight | Gets or sets the font weight used to draw the control's text. Inherited from TemplatedControl. |
| Foreground | Gets or sets the brush used to draw the control's text and other foreground elements. Inherited from TemplatedControl. |
| GestureRecognizers | Inherited from InputElement. |
| HasMirrorTransform | Gets or sets a value indicating whether to apply mirror transform on this control. Inherited from Visual. |
| Height | Gets or sets the height of the element. Inherited from Layoutable. |
| HorizontalAlignment | Gets or sets the element's preferred horizontal alignment in its parent. Inherited from Layoutable. |
| IsArrangeValid | Gets a value indicating whether the control's layouts arrange is valid. Inherited from Layoutable. |
| IsEffectivelyEnabled | Gets a value indicating whether this control and all its parents are enabled. Inherited from InputElement. |
| IsEffectivelyVisible | Gets a value indicating whether this control and all its parents are visible. Inherited from Visual. |
| IsEnabled | Gets or sets a value indicating whether the control is enabled for user interaction. Inherited from InputElement. |
| IsFocused | Gets a value indicating whether the control is focused. Inherited from InputElement. |
| IsHitTestVisible | Gets or sets a value indicating whether the control is considered for hit testing. Inherited from InputElement. |
| IsInitialized | Gets a value that indicates whether the element has finished initialization. Inherited from StyledElement. |
| IsKeyboardFocusWithin | Gets a value indicating whether keyboard focus is anywhere within the element or its visual tree child elements. Inherited from InputElement. |
| IsLoaded | Gets a value indicating whether the control is fully constructed in the visual tree and both layout and render are complete. Inherited from Control. |
| IsMeasureValid | Gets a value indicating whether the control's layout measure is valid. Inherited from Layoutable. |
| IsPointerOver | Gets a value indicating whether the pointer is currently over the control. Inherited from InputElement. |
| IsSwipeEnabled | Gets or sets whether swipe gestures are enabled for navigating between pages. When enabled, mouse pointer events are also accepted in addition to touch and pen. |
| IsSwiping | Gets a value indicating whether a swipe gesture is currently in progress. |
| IsTabStop | Gets or sets a value that indicates whether the control is included in tab navigation. Inherited from InputElement. |
| IsTextSearchEnabled | Gets or sets a value that specifies whether a user can jump to a value by typing. Inherited from SelectingItemsControl. |
| IsVisible | Gets or sets a value indicating whether this control is visible. Inherited from Visual. |
| Item | Inherited from AvaloniaObject. |
| ItemContainerGenerator | Gets the Avalonia.Controls.ItemsControl.ItemContainerGenerator for the control. Inherited from ItemsControl. |
| ItemContainerTheme | Gets or sets the Avalonia.Styling.ControlTheme that is applied to the container element generated for each item. Inherited from ItemsControl. |
| ItemCount | Gets the number of items being displayed by the Avalonia.Controls.ItemsControl. Inherited from ItemsControl. |
| Items | Gets the items to display. Inherited from ItemsControl. |
| ItemsPanel | Gets or sets the panel used to display the items. Inherited from ItemsControl. |
| ItemsPanelRoot | Gets the Avalonia.Controls.Panel specified by Avalonia.Controls.ItemsControl.ItemsPanel. Inherited from ItemsControl. |
| ItemsSource | Gets or sets a collection used to generate the content of the Avalonia.Controls.ItemsControl. Inherited from ItemsControl. |
| ItemsView | Gets a read-only view of the items in the Avalonia.Controls.ItemsControl. Inherited from ItemsControl. |
| ItemTemplate | Gets or sets the data template used to display the items in the control. Inherited from ItemsControl. |
| KeyBindings | Inherited from InputElement. |
| LetterSpacing | Gets or sets the letter spacing for the control's text content. Inherited from TemplatedControl. |
| Margin | Gets or sets the margin around the element. Inherited from Layoutable. |
| MaxHeight | Gets or sets the maximum height of the element. Inherited from Layoutable. |
| MaxWidth | Gets or sets the maximum width of the element. Inherited from Layoutable. |
| MinHeight | Gets or sets the minimum height of the element. Inherited from Layoutable. |
| MinWidth | Gets or sets the minimum width of the element. Inherited from Layoutable. |
| Name | Gets or sets the name of the styled element. Inherited from StyledElement. |
| Opacity | Gets or sets the opacity of the control. Inherited from Visual. |
| OpacityMask | Gets or sets the opacity mask of the control. Inherited from Visual. |
| Padding | Gets or sets the padding placed between the border of the control and its content. Inherited from TemplatedControl. |
| PageTransition | Gets or sets the transition to use when moving between pages. |
| Parent | Gets the styled element's logical parent. Inherited from StyledElement. |
| Presenter | Gets the items presenter control. Inherited from ItemsControl. |
| RenderTransform | Gets or sets the render transform of the control. Inherited from Visual. |
| RenderTransformOrigin | Gets or sets the transform origin of the control. Inherited from Visual. |
| Resources | Gets or sets the styled element's resource dictionary. Inherited from StyledElement. |
| SelectedIndex | Gets or sets the index of the selected item. Inherited from SelectingItemsControl. |
| SelectedItem | Gets or sets the selected item. Inherited from SelectingItemsControl. |
| SelectedValue | Gets or sets the value of the selected item, obtained using Avalonia.Controls.Primitives.SelectingItemsControl.SelectedValueBinding Inherited from SelectingItemsControl. |
| SelectedValueBinding | Gets the Avalonia.Data.BindingBase instance used to obtain the Avalonia.Controls.Primitives.SelectingItemsControl.SelectedValue property Inherited from SelectingItemsControl. |
| StyleKey | Gets the type by which the element is styled. Inherited from StyledElement. |
| Styles | Gets the styles for the styled element. Inherited from StyledElement. |
| TabIndex | Gets or sets a value that determines the order in which elements receive focus when the user navigates through controls by pressing the Tab key. Inherited from InputElement. |
| Tag | Gets or sets a user-defined object attached to the control. Inherited from Control. |
| Template | Gets or sets the template that defines the control's appearance. Inherited from TemplatedControl. |
| TemplatedParent | Gets the styled element whose lookless template this styled element is part of. Inherited from StyledElement. |
| Theme | Gets or sets the theme to be applied to the element. Inherited from StyledElement. |
| Transitions | Gets or sets the property transitions for the control. Inherited from Animatable. |
| UseLayoutRounding | Gets or sets a value that determines whether the element should be snapped to pixel boundaries at layout time. Inherited from Layoutable. |
| VerticalAlignment | Gets or sets the element's preferred vertical alignment in its parent. Inherited from Layoutable. |
| ViewportFraction | Gets or sets the fraction of the viewport occupied by each page. A value of 1 shows a single full page; values below 1 reveal adjacent pages. |
| Width | Gets or sets the width of the element. Inherited from Layoutable. |
| WrapSelection | Gets or sets a value which indicates whether to wrap around when the first or last item is reached. Inherited from SelectingItemsControl. |
| ZIndex | Gets or sets the Z index of the control. Inherited from Visual. |
IsSwipeEnabled Property
Gets or sets whether swipe gestures are enabled for navigating between pages. When enabled, mouse pointer events are also accepted in addition to touch and pen.
public bool IsSwipeEnabled { get; set; }
IsSwiping Property
Gets a value indicating whether a swipe gesture is currently in progress.
public bool IsSwiping { get; set; }
PageTransition Property
Gets or sets the transition to use when moving between pages.
public Avalonia.Animation.IPageTransition PageTransition { get; set; }
ViewportFraction Property
Gets or sets the fraction of the viewport occupied by each page. A value of 1 shows a single full page; values below 1 reveal adjacent pages.
public double ViewportFraction { get; set; }
Fields
IsSwipeEnabledProperty Field
Defines the Avalonia.Controls.Carousel.IsSwipeEnabled property.
public Avalonia.StyledProperty<bool> IsSwipeEnabledProperty
IsSwipingProperty Field
Defines the Avalonia.Controls.Carousel.IsSwiping property.
public Avalonia.DirectProperty<Avalonia.Controls.Carousel, bool> IsSwipingProperty
PageTransitionProperty Field
Defines the Avalonia.Controls.Carousel.PageTransition property.
public Avalonia.StyledProperty<Avalonia.Animation.IPageTransition> PageTransitionProperty
ViewportFractionProperty Field
Defines the Avalonia.Controls.Carousel.ViewportFraction property.
public Avalonia.StyledProperty<double> ViewportFractionProperty
Events
| Name | Description |
|---|---|
| ActualThemeVariantChanged | Raised when the theme variant is changed on the element or an ancestor of the element. Inherited from StyledElement. |
| AttachedToLogicalTree | Raised when the styled element is attached to a rooted logical tree. Inherited from StyledElement. |
| AttachedToVisualTree | Raised when the control is attached to a rooted visual tree. Inherited from Visual. |
| ContainerClearing | Occurs each time a container is cleared. Inherited from ItemsControl. |
| ContainerIndexChanged | Occurs for each realized container when the index for the item it represents has changed. Inherited from ItemsControl. |
| ContainerPrepared | Occurs each time a container is prepared for use. Inherited from ItemsControl. |
| ContextCanceled | Occurs when the context input gesture continues into another gesture, to notify the element that the context flyout should not be opened. Inherited from InputElement. |
| ContextRequested | Occurs when the user has completed a context input gesture, such as a right-click. Inherited from InputElement. |
| DataContextChanged | Occurs when the Avalonia.StyledElement.DataContext property changes. Inherited from StyledElement. |
| DetachedFromLogicalTree | Raised when the styled element is detached from a rooted logical tree. Inherited from StyledElement. |
| DetachedFromVisualTree | Raised when the control is detached from a rooted visual tree. Inherited from Visual. |
| DoubleTapped | Occurs when the user briefly contacts and releases twice on a single point, without significant movement. Inherited from InputElement. |
| EffectiveViewportChanged | Occurs when the element's effective viewport changes. Inherited from Layoutable. |
| GettingFocus | Occurs before the control receives focus. Inherited from InputElement. |
| GotFocus | Occurs when the control receives focus. Inherited from InputElement. |
| Holding | Occurs when the user makes a single contact, then maintains contact beyond a given time threshold without releasing or making another contact. Inherited from InputElement. |
| Initialized | Occurs when the styled element has finished initialization. Inherited from StyledElement. |
| KeyDown | Occurs when a key is pressed while the control has focus. Inherited from InputElement. |
| KeyUp | Occurs when a key is released while the control has focus. Inherited from InputElement. |
| LayoutUpdated | Occurs when a layout pass completes for the control. Inherited from Layoutable. |
| Loaded | Occurs when the control has been fully constructed in the visual tree and both layout and render are complete. Inherited from Control. |
| LosingFocus | Occurs before the control loses focus. Inherited from InputElement. |
| LostFocus | Occurs when the control loses focus. Inherited from InputElement. |
| Pinch | Occurs when the user moves two contact points closer together. Inherited from InputElement. |
| PinchEnded | Occurs when the user releases both contact points used in a pinch gesture. Inherited from InputElement. |
| PointerCaptureLost | Occurs when the control or its child control loses the pointer capture for any reason, event will not be triggered for a parent control if capture was transferred to another child of that parent control. Inherited from InputElement. |
| PointerEntered | Occurs when the pointer enters the control. Inherited from InputElement. |
| PointerExited | Occurs when the pointer leaves the control. Inherited from InputElement. |
| PointerMoved | Occurs when the pointer moves over the control. Inherited from InputElement. |
| PointerPressed | Occurs when the pointer is pressed over the control. Inherited from InputElement. |
| PointerReleased | Occurs when the pointer is released over the control. Inherited from InputElement. |
| PointerTouchPadGestureMagnify | Occurs when the user moves two contact points away from each other on a touchpad. Inherited from InputElement. |
| PointerTouchPadGestureRotate | Occurs when the user places two contact points and moves them in a circular motion on a touchpad. Inherited from InputElement. |
| PointerTouchPadGestureSwipe | Occurs when the user performs a rapid dragging motion in a single direction on a touchpad. Inherited from InputElement. |
| PointerWheelChanged | Occurs when the mouse is scrolled over the control. Inherited from InputElement. |
| PreparingContainer | Occurs immediately before a container is prepared for use. Inherited from ItemsControl. |
| PropertyChanged | Raised when a Avalonia.AvaloniaProperty value changes on this object. Inherited from AvaloniaObject. |
| PullGesture | Occurs when the user drags from the edge of a control. Inherited from InputElement. |
| PullGestureEnded | Occurs when the user releases the pointer after a pull gesture. Inherited from InputElement. |
| ResourcesChanged | Occurs when a resource in this styled element or a parent styled element has changed. Inherited from StyledElement. |
| RightTapped | Occurs when the user briefly contacts and releases a single point, without significant movement, using a mechanism on the input device recognized as a right button or equivalent. Inherited from InputElement. |
| ScrollGesture | Occurs when the user continuously moves the pointer in the same direction within the control’s boundaries. Inherited from InputElement. |
| ScrollGestureEnded | Occurs when a scroll gesture has fully stopped, taking into account any inertial movement that continues the scroll after the user has released the pointer. Inherited from InputElement. |
| ScrollGestureInertiaStarting | Occurs within a scroll gesture, when the user releases the pointer, and scrolling continues by transitioning to momentum-based gliding movement. Inherited from InputElement. |
| SelectionChanged | Occurs when the control's selection changes. Inherited from SelectingItemsControl. |
| SizeChanged | Occurs when the bounds (actual size) of the control have changed. Inherited from Control. |
| SwipeGesture | Occurs when the user rapidly drags the pointer in a single direction across the control. Inherited from InputElement. |
| SwipeGestureEnded | Occurs when a swipe gesture ends on the control. Inherited from InputElement. |
| Tapped | Occurs when the user briefly contacts and releases a single point, without significant movement. Inherited from InputElement. |
| TemplateApplied | Raised when the control's template is applied. Inherited from TemplatedControl. |
| TextInput | Occurs when a user typed some text while the control has focus. Inherited from InputElement. |
| TextInputMethodClientRequested | Occurs when an input element gains input focus and input method is looking for the corresponding client Inherited from InputElement. |
| Unloaded | Occurs when the control is removed from the visual tree. Inherited from Control. |