A System.InvalidOperationException is thrown when adding event handlers to UITextViews

[rpendleton]

Microsoft Intune App SDK for MAUI.iOS Issue

Summary

Describe the bug:

After introducing the Intune App SDK to our .NET for iOS project, our app is encountering exceptions when trying to add event handlers to classes such as UITextView, especially when loaded from storyboards and NIBs. The crash doesn't occur if we remove the Intune SDK from our project.

To Reproduce:

Download and run the attached sample project, or:

1. Create a .NET for iOS project using dotnet new ios
2. Add a PackageReference for the Intune App SDK to the .csproj
3. Create a storyboard containing a UIViewController with a UITextView
4. Assign a class name to the view controller
5. Create an outlet from the text view to the view controller
6. Mark the view controller as the initial view controller for the storyboard
7. Update the AppDelegate to load the view controller from the storyboard, such as:

   var storyboard = UIStoryboard.FromName("ViewController", null);
   var vc = storyboard.InstantiateInitialViewController();
   Window.RootViewController = vc;
   

8. In the view controller's ViewDidLoad, attempt to add an event handler to the UITextView:

   TextView.Started += (sender, args) => Console.WriteLine("TextView.Started");
   

9. Build and run the app

Expected behavior:
The event handler should be successfully added, and should be invoked when appropriate.

Actual behavior:
The app crashes with an exception due to there being an unexpected delegate on the text view.

System.InvalidOperationException: Event registration is overwriting existing delegate. Either just use events or your own delegate: Foundation.NSObject UIKit.UITextView+_UITextViewDelegate
   at UIKit.UIApplication.EnsureEventAndDelegateAreNotMismatched(Object del, Type expectedType) in /Users/builder/azdo/_work/1/s/xamarin-macios/src/UIKit/UIApplication.cs:line 118
   at UIKit.UITextView.EnsureUITextViewDelegate() in /Users/builder/azdo/_work/1/s/xamarin-macios/src/build/dotnet/ios/generated-sources/UIKit/UITextView.g.cs:line 2943
   at UIKit.UITextView.add_Started(EventHandler value) in /Users/builder/azdo/_work/1/s/xamarin-macios/src/build/dotnet/ios/generated-sources/UIKit/UITextView.g.cs:line 3076
   at IntuneDelegateEventCrashes.ViewController.ViewDidLoad() in /Users/rpendleton/sd/research/IntuneDelegateEventCrashes/IntuneDelegateEventCrashes/ViewController.cs:line 13

Notes:

When using a debugger, we see that the text view has an unexpected delegate of type CMARnzoANXkfrCWEhqReusTm. From what we can see using lldb and when dumping symbols, this class seems to come from the Intune SDK.

In our case, we're specifically seeing this issue with UITextViews. We're unsure if the Intune SDK uses a similar approach when swizzling other UIKit controls though. If it does, those controls will need to be fixed too.

Details

• Device: iPhone 15 Pro Simulator
• iOS Version: 17.5
• Microsoft.Intune.Maui.Essentials.iOS Version: 19.7.0
• Build Operating System and Version: macOS 14.6.1 (23G93)
• .NET SDK: 8.0.401 (811edcc344)
• .NET iOS Workload: 17.5.8020/8.0.100
• JetBrains Rider Version: 2024.2.5

[wangxiaoms]

Hi, what is your use case, would UITextViewDelegate help your case?

[rpendleton]

We have a fairly large .NET for iOS application, and several customers have requested that we integrate it with the Intune App SDK. However, after doing so, a significant number of our unit tests and UI automation workflows are now encountering this exception.

We are open to investigating a switch to UITextViewDelegate as an alternative to event handlers, but we have some concerns with this. While this change might work for this specific case, we're unsure whether similar changes will be required for other UIKit components, either now or in the future. Refactoring our existing code from event handlers to delegates also comes with some inherent risk, especially if such changes become necessary at unexpected points in the future.

With that in mind, our primary concern is that integrating with the SDK caused issues with something as fundamental as Xamarin event handlers, which we use extensively throughout our application. This raises concerns about the current and long-term stability of our app when integrated with the SDK. Ideally, we would expect standard Xamarin features to continue to function as indented.