SwipeItem Class

Definition

Namespace:

Microsoft.UI.Xaml.Controls

Represents an individual command in a SwipeControl.

/// [Microsoft.UI.Xaml.CustomAttributes.MUXPropertyChangedCallback(enable=true)]
/// [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 SwipeItem : DependencyObject

[Microsoft.UI.Xaml.CustomAttributes.MUXPropertyChangedCallback(enable=true)]
[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 SwipeItem : DependencyObject

Public Class SwipeItem
Inherits DependencyObject

<SwipeItem .../>
-or-
<SwipeItem ...>
  content
</SwipeItem>

Inheritance

Object IInspectable DependencyObject SwipeItem

Attributes

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

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

SwipeItem()

Initializes a new instance of the SwipeItem class.

Properties

Background	Gets or sets a brush that provides the background of the control.
BackgroundProperty	Identifies the Background dependency property.
BehaviorOnInvoked	Gets or sets a value that indicates how a SwipeControl behaves after this item is invoked.
BehaviorOnInvokedProperty	Identifies the BehaviorOnInvoked dependency property.
Command	Gets or sets the command to execute when this item is invoked.
CommandParameter	Gets or sets the parameter to pass to the Command property.
CommandParameterProperty	Identifies the CommandParameter dependency property.
CommandProperty	Identifies the Command dependency property.
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)
Foreground	Gets or sets the brush that paints the text and icon of the item.
ForegroundProperty	Identifies the Foreground dependency property.
IconSource	Gets or sets the graphic content of the item.
IconSourceProperty	Identifies the IconSource dependency property.
Text	Gets or sets the text description displayed on the item.
TextProperty	Identifies the Text dependency property.

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.

See also

• SwipeControl
• SwipeItems
• SwipeMode
• SwipeBehaviorOnInvoked