[RC1] Implement Platform Args for Drag and Drop EventArgs

src/Compatibility/Core/src/iOS/DragAndDropDelegate.cs

@@ -147,8 +147,9 @@ public UIDragItem[] HandleDragStarting(View element, IVisualElementRenderer rend
 
 				if (args.Cancel)
 					return;
-
+#pragma warning disable CS0618 // Type or member is obsolete
 				if (!args.Handled)
+#pragma warning restore CS0618 // Type or member is obsolete
 				{
 					UIImage uIImage = null;
 					string clipDescription = String.Empty;

src/Controls/samples/Controls.Sample.UITests/Elements/DragAndDropEventArgs.xaml

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<ContentView xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
+             xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
+             AutomationId="DragAndDropEventArgs"
+             x:Class="Maui.Controls.Sample.DragAndDropEventArgs">
+    <StackLayout>
+        <StackLayout Orientation="Horizontal">
+            <Label HeightRequest="200" WidthRequest="200" AutomationId="LabelDragElement"
+                   Text="Drag me Over the Purple Box, off the purple box, drop me on the purple box, and then verify all the correct events fired">
+                <Label.GestureRecognizers>
+                    <DragGestureRecognizer DragStarting="DragStarting" DropCompleted="DropCompleted"></DragGestureRecognizer>
+                </Label.GestureRecognizers>
+            </Label>
+            <Label HeightRequest="200" HorizontalOptions="FillAndExpand" Background="Purple" AutomationId="DragTarget">
+                <Label.GestureRecognizers>
+                    <DropGestureRecognizer DragLeave="DragLeave" DragOver="DragOver" Drop="Drop"></DropGestureRecognizer>
+                </Label.GestureRecognizers>
+            </Label>
+        </StackLayout>
+        <Label x:Name="events" AutomationId="DragEventsLabel" Text="EventsLabel">
+            <Label.GestureRecognizers>
+                <DropGestureRecognizer></DropGestureRecognizer>
+            </Label.GestureRecognizers>
+        </Label>
+    </StackLayout>
+</ContentView>

src/Controls/samples/Controls.Sample.UITests/Elements/DragAndDropEventArgs.xaml.cs

@@ -0,0 +1,151 @@
+using Microsoft.Maui.Controls;
+using Microsoft.Maui.Controls.Xaml;
+
+namespace Maui.Controls.Sample;
+
+[XamlCompilation(XamlCompilationOptions.Compile)]
+public partial class DragAndDropEventArgs : ContentView
+{
+	bool _emittedDragOver = false;
+	public DragAndDropEventArgs()
+	{
+		InitializeComponent();
+	}
+
+	void AddEvent(string name)
+	{
+		events.Text += $"{name},";
+	}
+
+	void DragStarting(object sender, DragStartingEventArgs e)
+	{
+		_emittedDragOver = false;
+		if (e.PlatformArgs is PlatformDragStartingEventArgs platformArgs)
+		{
+#if IOS || MACCATALYST
+			if (platformArgs.Sender is not null)
+				AddEvent("DragStarting:" + nameof(platformArgs.Sender));
+			if (platformArgs.DragInteraction is not null)
+				AddEvent("DragStarting:" + nameof(platformArgs.DragInteraction));
+			if (platformArgs.DragSession is not null)
+				AddEvent("DragStarting:" + nameof(platformArgs.DragSession));
+#elif ANDROID
+			if (platformArgs.Sender is not null)
+				AddEvent("DragStarting:" + nameof(platformArgs.Sender));
+			if (platformArgs.MotionEvent is not null)
+				AddEvent("DragStarting:" + nameof(platformArgs.MotionEvent));
+#elif WINDOWS
+			if (platformArgs.Sender is not null)
+				AddEvent("DragStarting:" + nameof(platformArgs.Sender));
+			if (platformArgs.DragStartingEventArgs is not null)
+				AddEvent("DragStarting:" + nameof(platformArgs.DragStartingEventArgs));
+			AddEvent("DragStarting:" + nameof(platformArgs.Handled));
+#endif
+		}
+	}
+
+	void DropCompleted(object sender, DropCompletedEventArgs e)
+	{
+		if (e.PlatformArgs is PlatformDropCompletedEventArgs platformArgs)
+		{
+#if IOS || MACCATALYST
+			if (platformArgs.Sender is not null)
+				AddEvent("DropCompleted:" + nameof(platformArgs.Sender));
+			if (platformArgs.DropInteraction is not null)
+				AddEvent("DropCompleted:" + nameof(platformArgs.DropInteraction));
+			if (platformArgs.DropSession is not null)
+				AddEvent("DropCompleted:" + nameof(platformArgs.DropSession));
+#elif ANDROID
+			if (platformArgs.Sender is not null)
+				AddEvent("DropCompleted:" + nameof(platformArgs.Sender));
+			if (platformArgs.DragEvent is not null)
+				AddEvent("DropCompleted:" + nameof(platformArgs.DragEvent));
+#elif WINDOWS
+			if (platformArgs.Sender is not null)
+				AddEvent("DropCompleted:" + nameof(platformArgs.Sender));
+			if (platformArgs.DropCompletedEventArgs is not null)
+				AddEvent("DropCompleted:" + nameof(platformArgs.DropCompletedEventArgs));
+#endif
+		}
+	}
+
+	void DragLeave(object sender, DragEventArgs e)
+	{
+		if (e.PlatformArgs is PlatformDragEventArgs platformArgs)
+		{
+#if IOS || MACCATALYST
+			if (platformArgs.Sender is not null)
+				AddEvent("DragLeave:" + nameof(platformArgs.Sender));
+			if (platformArgs.DropInteraction is not null)
+				AddEvent("DragLeave:" + nameof(platformArgs.DropInteraction));
+			if (platformArgs.DropSession is not null)
+				AddEvent("DragLeave:" + nameof(platformArgs.DropSession));
+#elif ANDROID
+			if (platformArgs.Sender is not null)
+				AddEvent("DragLeave:" + nameof(platformArgs.Sender));
+			if (platformArgs.DragEvent is not null)
+				AddEvent("DragLeave:" + nameof(platformArgs.DragEvent));
+#elif WINDOWS
+			if (platformArgs.Sender is not null)
+				AddEvent("DragLeave:" + nameof(platformArgs.Sender));
+			if (platformArgs.DragEventArgs is not null)
+				AddEvent("DragLeave:" + nameof(platformArgs.DragEventArgs));
+			AddEvent("DragLeave:" + nameof(platformArgs.Handled));
+#endif
+		}
+	}
+
+	void DragOver(object sender, DragEventArgs e)
+	{
+		if (!_emittedDragOver) // This can generate a lot of noise, only add it once
+		{
+			if (e.PlatformArgs is PlatformDragEventArgs platformArgs)
+			{
+#if IOS || MACCATALYST
+				if (platformArgs.Sender is not null)
+					AddEvent("DragOver:" + nameof(platformArgs.Sender));
+				if (platformArgs.DropInteraction is not null)
+					AddEvent("DragOver:" + nameof(platformArgs.DropInteraction));
+				if (platformArgs.DropSession is not null)
+					AddEvent("DragOver:" + nameof(platformArgs.DropSession));
+#elif ANDROID
+				if (platformArgs.Sender is not null)
+					AddEvent("DragOver:" + nameof(platformArgs.Sender));
+				if (platformArgs.DragEvent is not null)
+					AddEvent("DragOver:" + nameof(platformArgs.DragEvent));
+#elif WINDOWS
+				if (platformArgs.Sender is not null)
+					AddEvent("DragOver:" + nameof(platformArgs.Sender));
+				if (platformArgs.DragEventArgs is not null)
+					AddEvent("DragOver:" + nameof(platformArgs.DragEventArgs));
+#endif
+			}
+			_emittedDragOver = true;
+		}
+	}
+
+	void Drop(object sender, DropEventArgs e)
+	{
+		if (e.PlatformArgs is PlatformDropEventArgs platformArgs)
+		{
+#if IOS || MACCATALYST
+			if (platformArgs.Sender is not null)
+				AddEvent("Drop:" + nameof(platformArgs.Sender));
+			if (platformArgs.DropInteraction is not null)
+				AddEvent("Drop:" + nameof(platformArgs.DropInteraction));
+			if (platformArgs.DropSession is not null)
+				AddEvent("Drop:" + nameof(platformArgs.DropSession));
+#elif ANDROID
+			if (platformArgs.Sender is not null)
+				AddEvent("Drop:" + nameof(platformArgs.Sender));
+			if (platformArgs.DragEvent is not null)
+				AddEvent("Drop:" + nameof(platformArgs.DragEvent));
+#elif WINDOWS
+			if (platformArgs.Sender is not null)
+				AddEvent("Drop:" + nameof(platformArgs.Sender));
+			if (platformArgs.DragEventArgs is not null)
+				AddEvent("Drop:" + nameof(platformArgs.DragEventArgs));
+#endif
+		}
+	}
+}

src/Controls/samples/Controls.Sample.UITests/Elements/DragAndDropGallery.cs

@@ -9,6 +9,7 @@ public DragAndDropGallery()
 		{
 			Add(new DragAndDropEvents());
 			Add(new DragAndDropBetweenLayouts());
+			Add(new DragAndDropEventArgs());
 		}
 	}
 }

src/Controls/src/Core/DragAndDrop/DragEventArgs.cs

@@ -24,10 +24,12 @@ public DragEventArgs(DataPackage dataPackage)
 		/// </summary>
 		/// <param name="dataPackage">The data package associated with the drag source.</param>
 		/// <param name="getPosition">The current location in the coordinate system of the drag.</param>
-		internal DragEventArgs(DataPackage dataPackage, Func<IElement?, Point?>? getPosition)
+		/// <param name="platformArgs">The platform-specific data associated with the drag.</param>
+		internal DragEventArgs(DataPackage dataPackage, Func<IElement?, Point?>? getPosition, PlatformDragEventArgs platformArgs)
 		{
 			Data = dataPackage;
 			_getPosition = getPosition;
+			PlatformArgs = platformArgs;
 		}
 
 		/// <summary>
@@ -40,6 +42,11 @@ internal DragEventArgs(DataPackage dataPackage, Func<IElement?, Point?>? getPosi
 		/// </summary>
 		public DataPackageOperation AcceptedOperation { get; set; } = DataPackageOperation.Copy;
 
+		/// <summary>
+		/// Gets the platform-specific arguments associated with the <see cref="DragEventArgs"/>.
+		/// </summary>
+		public PlatformDragEventArgs? PlatformArgs { get; }
+
 		/// <summary>
 		/// Gets the location of the drag relative to the specified element.
 		/// </summary>

src/Controls/src/Core/DragAndDrop/DragGestureRecognizer.cs

@@ -108,18 +108,22 @@ internal void SendDropCompleted(DropCompletedEventArgs args)
 			DropCompleted?.Invoke(this, args);
 		}
 
-		internal DragStartingEventArgs SendDragStarting(View element, Func<IElement?, Point?>? getPosition = null)
+		internal DragStartingEventArgs SendDragStarting(View element, Func<IElement?, Point?>? getPosition = null, PlatformDragStartingEventArgs? platformArgs = null)
 		{
-			var args = new DragStartingEventArgs(getPosition);
+			var args = new DragStartingEventArgs(getPosition, platformArgs);
 
 			DragStartingCommand?.Execute(DragStartingCommandParameter);
 			DragStarting?.Invoke(this, args);
 
+#pragma warning disable CS0618 // Type or member is obsolete
 			if (!args.Handled)
 				args.Data.PropertiesInternal.Add("DragSource", element);
+#pragma warning restore CS0618 // Type or member is obsolete
 
+#pragma warning disable CS0618 // Type or member is obsolete
 			if (args.Cancel || args.Handled)
 				return args;
+#pragma warning restore CS0618 // Type or member is obsolete
 
 			_isDragActive = true;
 

src/Controls/src/Core/DragAndDrop/DragStartingEventArgs.cs

@@ -1,4 +1,5 @@
 using System;
+using System.ComponentModel;
 using Microsoft.Maui.Graphics;
 
 namespace Microsoft.Maui.Controls
@@ -21,21 +22,30 @@ public DragStartingEventArgs()
 		/// Initializes a new instance of the <see cref="DragStartingEventArgs"/> class.
 		/// </summary>
 		/// <param name="getPosition">Function used to get the position relative a specified <see cref="IElement"/>.</param>
-		internal DragStartingEventArgs(Func<IElement?, Point?>? getPosition)
+		/// <param name="platformArgs">The platform-specific data associated with the drag.</param>
+		internal DragStartingEventArgs(Func<IElement?, Point?>? getPosition, PlatformDragStartingEventArgs? platformArgs)
 		{
 			_getPosition = getPosition;
+			PlatformArgs = platformArgs;
 		}
 
 		/// <summary>
 		/// Gets or sets a value that indicates whether the event handler has handled the event or whether .NET MAUI should continue its own processing.
 		/// </summary>
+		[EditorBrowsable(EditorBrowsableState.Never)]
+		[Obsolete("Use PlatformArgs to handle customization. On Windows, set the PlatformArgs.Handled property to true if changing DragStartingEventArgs.")]
 		public bool Handled { get; set; }
 
 		/// <summary>
 		/// Gets or sets a value that indicates whether the event should be canceled.
 		/// </summary>
 		public bool Cancel { get; set; }
 
+		/// <summary>
+		/// Gets the platform-specific arguments associated with the <see cref="DragStartingEventArgs"/>.
+		/// </summary>
+		public PlatformDragStartingEventArgs? PlatformArgs { get; }
+
 		/// <summary>
 		/// Gets the data package that accompanies the drag source.
 		/// </summary>

src/Controls/src/Core/DragAndDrop/DropCompletedEventArgs.cs

@@ -1,4 +1,3 @@
-#nullable disable
 using System;
 
 namespace Microsoft.Maui.Controls
@@ -7,5 +6,26 @@ namespace Microsoft.Maui.Controls
 	public class DropCompletedEventArgs : EventArgs
 	{
 		DataPackageOperation DropResult { get; }
+
+		/// <summary>
+		/// Initializes a new instance of the <see cref="DropCompletedEventArgs"/> class.
+		/// </summary>
+		public DropCompletedEventArgs()
+		{
+		}
+
+		/// <summary>
+		/// Initializes a new instance of the <see cref="DropCompletedEventArgs"/> class.
+		/// </summary>
+		/// <param name="platformArgs">The platform-specific data associated with the drag.</param>
+		internal DropCompletedEventArgs(PlatformDropCompletedEventArgs platformArgs) : this()
+		{
+			PlatformArgs = platformArgs;
+		}
+
+		/// <summary>
+		/// Gets the platform-specific arguments associated with the <see cref="DropCompletedEventArgs"/>.
+		/// </summary>
+		public PlatformDropCompletedEventArgs? PlatformArgs { get; }
 	}
 }

src/Controls/src/Core/DragAndDrop/DropEventArgs.cs

@@ -25,11 +25,12 @@ public DropEventArgs(DataPackageView view)
 		/// </summary>
 		/// <param name="view">The data package associated with the drop.</param>
 		/// <param name="getPosition">Function used to get the position relative a specified <see cref="IElement"/>.</param>
-		internal DropEventArgs(DataPackageView view, Func<IElement?, Point?>? getPosition)
+		/// <param name="platformArgs">The platform-specific data associated with the drag.</param>
+		internal DropEventArgs(DataPackageView? view, Func<IElement?, Point?>? getPosition, PlatformDropEventArgs platformArgs)
 		{
-			_ = view ?? throw new ArgumentNullException(nameof(view));
-			Data = view;
+			Data = view ?? new DataPackageView(new DataPackage());
 			_getPosition = getPosition;
+			PlatformArgs = platformArgs;
 		}
 
 		/// <summary>
@@ -44,6 +45,11 @@ internal DropEventArgs(DataPackageView view, Func<IElement?, Point?>? getPositio
 		/// </summary>
 		public bool Handled { get; set; }
 
+		/// <summary>
+		/// Gets the platform-specific arguments associated with the <see cref="DropEventArgs"/>.
+		/// </summary>
+		public PlatformDropEventArgs? PlatformArgs { get; }
+
 		/// <summary>
 		/// Gets the location of the drag relative to the specified element.
 		/// </summary>