SwipeItem Class

Definition

Represents an individual command in a SwipeControl.

Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Controls.SwipeItem (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

C#
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 327680)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public class SwipeItem : DependencyObject
XAML
<SwipeItem .../>
-or-
<SwipeItem ...>
  content
</SwipeItem>
Inheritance
Object DependencyObject SwipeItem
Attributes

Windows requirements

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

Constructors

SwipeItem()

Initializes a new instance of the SwipeItem class.

Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Controls.SwipeItem.-ctor (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

Properties

Background

Gets or sets a brush that provides the background of the control.

Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Controls.SwipeItem.Background (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

BackgroundProperty

Identifies the Background dependency property.

Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Controls.SwipeItem.BackgroundProperty (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

BehaviorOnInvoked

Gets or sets a value that indicates how a SwipeControl behaves after this item is invoked.

Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Controls.SwipeItem.BehaviorOnInvoked (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

BehaviorOnInvokedProperty

Identifies the BehaviorOnInvoked dependency property.

Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Controls.SwipeItem.BehaviorOnInvokedProperty (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

Command

Gets or sets the command to execute when this item is invoked.

Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Controls.SwipeItem.Command (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

CommandParameter

Gets or sets the parameter to pass to the Command property.

Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Controls.SwipeItem.CommandParameter (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

CommandParameterProperty

Identifies the CommandParameter dependency property.

Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Controls.SwipeItem.CommandParameterProperty (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

CommandProperty

Identifies the Command dependency property.

Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Controls.SwipeItem.CommandProperty (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

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.

(Inherited from DependencyObject)
Foreground

Gets or sets the brush that paints the text and icon of the item.

Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Controls.SwipeItem.Foreground (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

ForegroundProperty

Identifies the Foreground dependency property.

Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Controls.SwipeItem.ForegroundProperty (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

IconSource

Gets or sets the graphic content of the item.

Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Controls.SwipeItem.IconSource (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

IconSourceProperty

Identifies the IconSource dependency property.

Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Controls.SwipeItem.IconSourceProperty (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

Text

Gets or sets the text description displayed on the item.

Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Controls.SwipeItem.Text (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

TextProperty

Identifies the Text dependency property.

Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Controls.SwipeItem.TextProperty (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

Methods

ClearValue(DependencyProperty)

Clears the local value of a dependency property.

(Inherited from DependencyObject)
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)
GetValue(DependencyProperty)

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

(Inherited from DependencyObject)
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)
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)

Events

Invoked

Occurs when user interaction indicates that the command represented by this item should execute.

Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Controls.SwipeItem.Invoked (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

Applies to

Product Versions
WinRT Build 16299, Build 17134, Build 17763, Build 18362, Build 19041, Build 20348, Build 22000, Build 22621, Build 26100