Add first WinForms Async experimental APIs #11828

KlausLoeffelmann · 2024-08-06T23:39:16Z

Note: This PR is based on #10985.
That's why this PR has been based against feature/darkmode which holds the exact copy of the DarkMode feature.

Introduces new experimental APIs for .NET 9:

Control.InvokeAsync.
TaskDialog.ShowDialogAsync.
Form.ShowAsync.
Form.ShowDialogAsync

Fixes #10739.
Replaces #9827.

src/System.Windows.Forms/src/System.Windows.Forms.csproj

src/System.Windows.Forms/src/System/Windows/Forms/Control.ControlNativeWindow.cs

src/System.Windows.Forms/src/System/Windows/Forms/Control.cs

JeremyKuhne · 2024-08-07T02:24:55Z

src/System.Windows.Forms/src/System/Windows/Forms/Control.cs

@@ -6858,6 +6858,14 @@ private bool NotifyValidating()
        return ev.Cancel;
    }

+    /// <summary>
+    ///  Called by the NativeWindow callback, when an exception is caught. This will be rerouted to the
+    ///  Application.ThreadException, but in certain Async scenarios it makes more sense, to be able to


What certain scenarios?

Showing Forms, whose Exception handling was always handled unfortunate to begin with, maybe later also Popups for .NET 10.

Example: Throw an exception in Form.OnLoad and try to gracefully handle it, when you Show (not Dialog-show) the form from another form. It's a discoverability nightmare for so many folks. My aim is it to make it more intuitively. And retrofit at least analyzers for it later.

The example needs added in remarks. Pull out everything but the summary into remarks.

JeremyKuhne · 2024-08-07T02:26:01Z

src/System.Windows.Forms/src/System/Windows/Forms/Control_InvokeAsync.cs

+    /// <param name="action">The synchronous action to execute.</param>
+    /// <param name="cancellationToken">The cancellation token.</param>
+    /// <returns>A task representing the operation and containing the function's result.</returns>
+    [Experimental(DiagnosticIDs.ExperimentalAsync, UrlFormat = "https://aka.ms/winforms-experimental/{0}")]


I thought the plan was for these ones (InvokeAsync) to not be experimental.

I'll ask Immo.

I am with you, but then I would beg you to keep the option for me to REALLY test InvokeAsync additionally coming Saturday and Sunday and then, should I find something, do a follow-up PR before we snap on Sunday afternoon. Would you let me?

Yes. Not experimental.

src/System.Windows.Forms/src/System/Windows/Forms/Controls/ListView/ListView.cs

src/System.Windows.Forms/src/System/Windows/Forms/Dialogs/MessageBox.cs

src/System.Windows.Forms/src/System/Windows/Forms/Form.cs

src/System.Windows.Forms/src/System/Windows/Forms/Control_InvokeAsync.cs

src/System.Windows.Forms/src/System/Windows/Forms/Application.cs

src/System.Windows.Forms/src/System/Windows/Forms/Dialogs/TaskDialog/TaskDialog.cs

src/System.Windows.Forms/src/System/Windows/Forms/Form.cs

...sualBasic.Forms/src/Microsoft/VisualBasic/ApplicationServices/WindowsFormsApplicationBase.vb

KlausLoeffelmann · 2024-08-09T21:52:24Z

Closing this PR, as it needs to be cherry-picked into a new one based on main.
#11854.

merriemcgaw · 2024-08-09T22:27:35Z

Note that this is not dead, we're simply trying to detangle it from some other work to ensure it gets in for RC1 as an encapsulated change rather than dependent on other PRs in flight.

KlausLoeffelmann self-assigned this Aug 6, 2024

KlausLoeffelmann changed the base branch from main to feature/DarkMode August 6, 2024 23:59

KlausLoeffelmann mentioned this pull request Aug 7, 2024

Implement first draft of Control.InvokeAsync, MessageBox.ShowAsync an… #9827

Closed

dotnet-policy-service bot added the draft draft PR label Aug 7, 2024