SwipeItems Class

Definition

Represents a collection of SwipeItem objects.

/// [Windows.Foundation.Metadata.Composable(Windows.UI.Xaml.Controls.ISwipeItemsFactory, Windows.Foundation.Metadata.CompositionType.Public, 327680, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 327680)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.ISwipeItemsStatics, 327680, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[WebHostHidden]
class SwipeItems : DependencyObject, IIterable<SwipeItem>, IVector<SwipeItem>
/// [Windows.Foundation.Metadata.Composable(Windows.UI.Xaml.Controls.ISwipeItemsFactory, Windows.Foundation.Metadata.CompositionType.Public, 327680, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 327680)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.ISwipeItemsStatics, 327680, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.WebHostHidden]
class SwipeItems : DependencyObject, IIterable<SwipeItem>, IVector<SwipeItem>
[Windows.Foundation.Metadata.Composable(typeof(Windows.UI.Xaml.Controls.ISwipeItemsFactory), Windows.Foundation.Metadata.CompositionType.Public, 327680, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 327680)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.ISwipeItemsStatics), 327680, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public class SwipeItems : DependencyObject, IEnumerable<SwipeItem>, IList<SwipeItem>
[Windows.Foundation.Metadata.Composable(typeof(Windows.UI.Xaml.Controls.ISwipeItemsFactory), Windows.Foundation.Metadata.CompositionType.Public, 327680, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 327680)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.ISwipeItemsStatics), 327680, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.WebHostHidden]
public class SwipeItems : DependencyObject, IEnumerable<SwipeItem>, IList<SwipeItem>
function SwipeItems()
Public Class SwipeItems
Inherits DependencyObject
Implements IEnumerable(Of SwipeItem), IList(Of SwipeItem)
<SwipeControl>
  <SwipeControl.TopItems>
    oneOrMoreSwipeItemDefinitions
  </SwipeControl.TopItems>
</SwipeControl>
Inheritance
Attributes
Implements

Windows 10 requirements

Device family
Windows 10 Fall Creators Update (introduced in 10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v5.0)

Examples

Tip

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

If you have the XAML Controls Gallery app installed, click here to open the app and see the SwipeControl in action.

Constructors

SwipeItems()

Initializes a new instance of the SwipeItems class.

Properties

Dispatcher

Gets the CoreDispatcher that this object is associated with. The CoreDispatcher represents a facility that can access the DependencyObject on the UI thread even if the code is initiated by a non-UI thread.

Equivalent WinUI property: Microsoft.UI.Xaml.DependencyObject.Dispatcher.

(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.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.SwipeItems.Append.

Clear()

Removes all items from the collection.

ClearValue(DependencyProperty)

Clears the local value of a dependency property.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.ClearValue.

(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.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.GetAnimationBaseValue.

(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.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.SwipeItems.GetMany.

GetValue(DependencyProperty)

Returns the current effective value of a dependency property from a DependencyObject.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.GetValue.

(Inherited from DependencyObject)
GetView()

Gets an immutable view into the collection.

IndexOf(SwipeItem, UInt32)

Retrieves the index of the specified item.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.SwipeItems.IndexOf.

InsertAt(UInt32, SwipeItem)

Inserts the specified item at the specified index.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.SwipeItems.InsertAt.

ReadLocalValue(DependencyProperty)

Returns the local value of a dependency property, if a local value is set.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.ReadLocalValue.

(Inherited from DependencyObject)
RegisterPropertyChangedCallback(DependencyProperty, DependencyPropertyChangedCallback)

Registers a notification function for listening to changes to a specific DependencyProperty on this DependencyObject instance.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.RegisterPropertyChangedCallback.

(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.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.SwipeItems.ReplaceAll.

SetAt(UInt32, SwipeItem)

Sets the value at the specified index to the value specified.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.SwipeItems.SetAt.

SetValue(DependencyProperty, Object)

Sets the local value of a dependency property on a DependencyObject.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.SetValue.

(Inherited from DependencyObject)
UnregisterPropertyChangedCallback(DependencyProperty, Int64)

Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.UnregisterPropertyChangedCallback.

(Inherited from DependencyObject)

Applies to