SwipeItems Class

Definition

Namespace:

Microsoft.UI.Xaml.Controls

Represents a collection of SwipeItem objects.

/// [Microsoft.UI.Xaml.CustomAttributes.MUXPropertyChangedCallbackMethodName(value="OnPropertyChanged")]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.UI.Xaml.XamlContract, 65536)]
class SwipeItems : DependencyObject, IIterable<SwipeItem>, IVector<SwipeItem>

[Microsoft.UI.Xaml.CustomAttributes.MUXPropertyChangedCallbackMethodName(value="OnPropertyChanged")]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.UI.Xaml.XamlContract), 65536)]
public class SwipeItems : DependencyObject, IEnumerable<SwipeItem>, IList<SwipeItem>

Public Class SwipeItems
Inherits DependencyObject
Implements IEnumerable(Of SwipeItem), IList(Of SwipeItem)

<SwipeControl>
  <SwipeControl.TopItems>
    oneOrMoreSwipeItemDefinitions
  </SwipeControl.TopItems>
</SwipeControl>

Inheritance

Object IInspectable DependencyObject SwipeItems

Attributes

Microsoft.UI.Xaml.CustomAttributes.MUXPropertyChangedCallbackMethodNameAttribute MarshalingBehaviorAttribute ThreadingAttribute ContractVersionAttribute

Implements

IIterable<SwipeItem> IEnumerable<SwipeItem> IIterable<T> IEnumerable<T> IVector<SwipeItem> IList<SwipeItem>

Examples

Tip

For more info, design guidance, and code examples, see Swipe.

Open the WinUI 3 Gallery app and see the SwipeControl in action.

The WinUI 3 Gallery app includes interactive examples of most WinUI 3 controls, features, and functionality. Get the app from the Microsoft Store or get the source code on GitHub.

Constructors

SwipeItems()

Initializes a new instance of the SwipeItems class.

Properties

Dispatcher	Always returns null in a Windows App SDK app. Use DispatcherQueue instead. (Inherited from DependencyObject)
DispatcherQueue	Gets the DispatcherQueue that this object is associated with. The DispatcherQueue represents a facility that can access the DependencyObject on the UI thread even if the code is initiated by a non-UI thread. (Inherited from DependencyObject)
Mode	Gets or sets a value that indicates the effect of a swipe interaction.
ModeProperty	Identifies the Mode dependency property.
Size	Gets the size (count) of the collection.

Methods

Append(SwipeItem)	Adds a new item to the collection.
Clear()	Removes all items from the collection.
ClearValue(DependencyProperty)	Clears the local value of a dependency property. (Inherited from DependencyObject)
First()	Returns an iterator for the items in the collection.
GetAnimationBaseValue(DependencyProperty)	Returns any base value established for a dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject)
GetAt(UInt32)	Returns the item located at the specified index.
GetMany(UInt32, SwipeItem[])	Retrieves multiple elements in a single pass through the iterator.
GetValue(DependencyProperty)	Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject)
GetView()	Gets an immutable view into the collection.
IndexOf(SwipeItem, UInt32)	Retrieves the index of the specified item.
InsertAt(UInt32, SwipeItem)	Inserts the specified item at the specified index.
ReadLocalValue(DependencyProperty)	Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject)
RegisterPropertyChangedCallback(DependencyProperty, DependencyPropertyChangedCallback)	Registers a notification function for listening to changes to a specific DependencyProperty on this DependencyObject instance. (Inherited from DependencyObject)
RemoveAt(UInt32)	Removes the item at the specified index.
RemoveAtEnd()	Removes the last item in the collection.
ReplaceAll(SwipeItem[])	Initially clears the collection, then inserts the provided array as new items.
SetAt(UInt32, SwipeItem)	Sets the value at the specified index to the value specified.
SetValue(DependencyProperty, Object)	Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject)
UnregisterPropertyChangedCallback(DependencyProperty, Int64)	Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback. (Inherited from DependencyObject)

See also

• SwipeControl
• SwipeItem
• SwipeMode
• SwipeBehaviorOnInvoked