Adding new strongly typed methods to Clipboard, DataObject and IDataObject. #11545

Tanya-Solyanik · 2024-06-18T07:51:44Z

Related to ##12362
Fixes #11350

The TryGetData methods use NRBF deserializer by default and will fall back to use BinaryFormatter if the application opts into BinaryFormatter use in this context.
The GetData methods have a compatibility mode when the appropriate AppContext switches are enabled but by default they can read only known and primitive types or POCOs with primitive fields. These methods in the DataObject class are obsoleted.

Microsoft Reviewers: Open in CodeFlow

...ndows.Forms/src/System/Windows/Forms/BinaryFormat/WinFormsBinaryFormattedObjectExtensions.cs

.../System/Windows/Forms/OLE/DataObject.ComposedDataObject.NativeDataObjectToWinFormsAdapter.cs

src/System.Windows.Forms/src/System/Windows/Forms/OLE/Clipboard.cs

.../System/Windows/Forms/OLE/DataObject.ComposedDataObject.NativeDataObjectToWinFormsAdapter.cs

src/System.Windows.Forms/src/System/Windows/Forms/OLE/DataObject.cs

JeremyKuhne

Added some comments.

src/System.Windows.Forms/src/System/Windows/Forms/OLE/ComposedBinder.cs

src/System.Windows.Forms/src/System/Windows/Forms/OLE/Clipboard.cs

.../System/Windows/Forms/OLE/DataObject.ComposedDataObject.NativeDataObjectToWinFormsAdapter.cs

JeremyKuhne

Added some more comments. I'm a little concerned that we're using TypeName where it isn't necessary in some cases. We should optimize this before we fully validate this as changing it afterwords would be risky.

I still need to spend more time reviewing.

src/System.Windows.Forms/src/System/Windows/Forms/BinaryFormat/WinFormsArrayRecordExtensions.cs

...ndows.Forms/src/System/Windows/Forms/BinaryFormat/WinFormsBinaryFormattedObjectExtensions.cs

src/System.Windows.Forms/src/System/Windows/Forms/OLE/ComposedBinder.cs

.../System/Windows/Forms/OLE/DataObject.ComposedDataObject.NativeDataObjectToWinFormsAdapter.cs

src/System.Windows.Forms/src/System/Windows/Forms/OLE/IDataObject.cs

JeremyKuhne

We should not be falling into the default interface implementations for our own types that derive from IDataObject.

Directory.Build.props

src/System.Windows.Forms/src/System/Windows/Forms/OLE/DataObject.cs

src/System.Windows.Forms/src/System/Windows/Forms/OLE/IDataObject.cs

src/System.Windows.Forms/src/System/Windows/Forms/OLE/DataObject.cs

codecov · 2024-06-25T09:09:07Z

Codecov Report

Attention: Patch coverage is 93.00605% with 104 lines in your changes missing coverage. Please review.

Project coverage is 97.03763%. Comparing base (0b07c20) to head (38fd447).
Report is 2 commits behind head on main.

Additional details and impacted files

@@                 Coverage Diff                  @@
##                main      #11545          +/-   ##
====================================================
+ Coverage   75.91821%   97.03763%   +21.11941%     
====================================================
  Files           3164        1182        -1982     
  Lines         636813      354547      -282266     
  Branches       47008        5410       -41598     
====================================================
- Hits          483457      344044      -139413     
+ Misses        149901        9711      -140190     
+ Partials        3455         792        -2663

Flag	Coverage Δ
Debug	`97.03763% <93.00605%> (+21.11941%)`	⬆️
integration	`?`
production	`?`
test	`97.03763% <93.00605%> (-0.01368%)`	⬇️
unit	`?`

Flags with carried forward coverage won't be shown. Click here to find out more.

src/System.Windows.Forms/src/System/Windows/Forms/OLE/DataObject.cs

src/System.Windows.Forms/src/System/Windows/Forms/OLE/Clipboard.cs

...m.Windows.Forms/src/System/Windows/Forms/OLE/DataObject.Composition.BinaryFormatUtilities.cs

src/System.Windows.Forms/src/System/Windows/Forms/OLE/DataObject.DataStore.cs

src/System.Windows.Forms/src/System/Windows/Forms/OLE/DataObject.cs

lonitra · 2024-12-09T18:17:56Z

src/System.Windows.Forms/src/System/Windows/Forms/OLE/ITypedDataObject.cs

+
+namespace System.Windows.Forms;
+
+public interface ITypedDataObject


Is there a resolution to this thread? It still seems our guidance is that both should be implemented.

...ows.Forms/tests/UnitTests/System/Windows/Forms/BinaryFormatUtilitiesTests.FullCompatScope.cs

src/System.Windows.Forms/tests/UnitTests/System/Windows/Forms/DragDropHelperTests.cs

src/System.Windows.Forms/tests/UnitTests/System/Windows/Forms/NativeToWinFormsAdapterTests.cs

...Windows.Forms/src/System/Windows/Forms/OLE/DataObject.Composition.NativeToWinFormsAdapter.cs

src/System.Windows.Forms/tests/UnitTests/System/Windows/Forms/NativeToWinFormsAdapterTests.cs

… for example when the OOB Formatters assembly is not referenced of enabled.

…riting data to it

…re, string interpolation in test file; simplify code to read forwarded from attribute

generate TYpeName taking into account what assembly the type was forwarded from

src/System.Windows.Forms/src/System/Windows/Forms/Internal/TypeExtensions.cs

lonitra · 2024-12-11T22:42:03Z

src/System.Windows.Forms/src/System/Windows/Forms/OLE/Clipboard.cs

+
+        if (dataObject is not ITypedDataObject typedDataObject)
+        {
+            // TODO (TanyaSo): localize string


Assuming this will be done in follow up PR?

src/System.Windows.Forms/src/System/Windows/Forms/OLE/DataObject.Composition.Binder.cs

...ystem.Windows.Forms.Primitives/src/System/LocalAppContextSwitches/LocalAppContextSwitches.cs

@lonitra

My issues are addressed, letting @lonitra do the final sign-off.

lonitra

LGTM, nice! 🚀

dotnet-policy-service bot assigned Tanya-Solyanik Jun 18, 2024

dotnet-policy-service bot added the draft draft PR label Jun 18, 2024

Tanya-Solyanik force-pushed the cb-9 branch 3 times, most recently from e246a67 to a89070f Compare June 18, 2024 15:12

lonitra reviewed Jun 18, 2024

View reviewed changes

JeremyKuhne requested changes Jun 20, 2024

View reviewed changes

dotnet-policy-service bot added 📭 waiting-author-feedback The team requires more information from the author and removed 📭 waiting-author-feedback The team requires more information from the author labels Jun 20, 2024

Tanya-Solyanik force-pushed the cb-9 branch 6 times, most recently from 816f4c9 to 7cc2fdc Compare June 24, 2024 15:19

JeremyKuhne requested changes Jun 24, 2024

View reviewed changes

dotnet-policy-service bot added 📭 waiting-author-feedback The team requires more information from the author and removed 📭 waiting-author-feedback The team requires more information from the author labels Jun 24, 2024

Tanya-Solyanik force-pushed the cb-9 branch 2 times, most recently from b670471 to c1e4bcd Compare June 24, 2024 20:37

JeremyKuhne requested changes Jun 24, 2024

View reviewed changes

dotnet-policy-service bot added 📭 waiting-author-feedback The team requires more information from the author and removed 📭 waiting-author-feedback The team requires more information from the author labels Jun 24, 2024

Tanya-Solyanik force-pushed the cb-9 branch 3 times, most recently from 7903b3c to 9f06188 Compare July 24, 2024 21:20

lonitra changed the base branch from feature/clipboard to feature/10.0 July 30, 2024 20:12

lonitra changed the base branch from feature/10.0 to main August 15, 2024 00:59

Tanya-Solyanik force-pushed the cb-9 branch from 04ce40e to 6d88963 Compare October 10, 2024 22:47

lonitra reviewed Dec 9, 2024

View reviewed changes

src/System.Windows.Forms/src/System/Windows/Forms/OLE/DataObject.cs Show resolved Hide resolved

lonitra reviewed Dec 9, 2024

View reviewed changes

src/System.Windows.Forms/src/System/Windows/Forms/OLE/Clipboard.cs Outdated Show resolved Hide resolved

lonitra reviewed Dec 9, 2024

View reviewed changes

...m.Windows.Forms/src/System/Windows/Forms/OLE/DataObject.Composition.BinaryFormatUtilities.cs Show resolved Hide resolved

lonitra reviewed Dec 9, 2024

View reviewed changes

src/System.Windows.Forms/tests/UnitTests/System/Windows/Forms/DragDropHelperTests.cs Outdated Show resolved Hide resolved

src/System.Windows.Forms/tests/UnitTests/System/Windows/Forms/NativeToWinFormsAdapterTests.cs Outdated Show resolved Hide resolved

Tanya-Solyanik commented Dec 9, 2024

View reviewed changes

...Windows.Forms/src/System/Windows/Forms/OLE/DataObject.Composition.NativeToWinFormsAdapter.cs Show resolved Hide resolved

Tanya-Solyanik force-pushed the cb-9 branch 2 times, most recently from dfb875e to 394e1d4 Compare December 10, 2024 01:20

Tanya-Solyanik commented Dec 10, 2024

View reviewed changes

src/System.Windows.Forms/tests/UnitTests/System/Windows/Forms/NativeToWinFormsAdapterTests.cs Show resolved Hide resolved

Tanya-Solyanik force-pushed the cb-9 branch 2 times, most recently from 3d6a09b to 15a3b48 Compare December 11, 2024 20:31

Tanya-Solyanik added 8 commits December 11, 2024 12:45

reactive changes

993f011

Implemented ITypedDataObject

1e1fcb0

Throw the NotSupportedException that was serialized to the clipboard,…

101f75d

… for example when the OOB Formatters assembly is not referenced of enabled.

Do not attempt to read HGLOBAL if managed serialization failed when w…

488325d

…riting data to it

Review feedback - renamed the test scope, pattern matching in DataSto…

2f4b81e

…re, string interpolation in test file; simplify code to read forwarded from attribute

ITypedDataObject implements IDataObject

63c1a61

match known types using TypeNames

6e976df

generate TYpeName taking into account what assembly the type was forwarded from

Merging the BitmapBinder removal

72216fb

Tanya-Solyanik force-pushed the cb-9 branch from 15a3b48 to 72216fb Compare December 11, 2024 22:26

lonitra reviewed Dec 11, 2024

View reviewed changes

Added comments and update unit tests to

38fd447

lonitra approved these changes Dec 12, 2024

View reviewed changes

Tanya-Solyanik marked this pull request as ready for review December 12, 2024 00:54

Tanya-Solyanik requested a review from a team as a code owner December 12, 2024 00:54

Tanya-Solyanik merged commit f091e7b into dotnet:main Dec 12, 2024
8 checks passed

Tanya-Solyanik deleted the cb-9 branch December 12, 2024 00:55

dotnet-policy-service bot added this to the 10.0 Preview1 milestone Dec 12, 2024

github-actions bot locked and limited conversation to collaborators Jan 11, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding new strongly typed methods to Clipboard, DataObject and IDataObject. #11545

Adding new strongly typed methods to Clipboard, DataObject and IDataObject. #11545

Tanya-Solyanik commented Jun 18, 2024 •

edited

Loading

JeremyKuhne left a comment

JeremyKuhne left a comment

JeremyKuhne left a comment

codecov bot commented Jun 25, 2024 •

edited

Loading

lonitra Dec 9, 2024

lonitra Dec 11, 2024

Tanya-Solyanik Dec 11, 2024

lonitra left a comment


		namespace System.Windows.Forms;

		public interface ITypedDataObject

Adding new strongly typed methods to Clipboard, DataObject and IDataObject. #11545

Adding new strongly typed methods to Clipboard, DataObject and IDataObject. #11545

Conversation

Tanya-Solyanik commented Jun 18, 2024 • edited Loading

Microsoft Reviewers: Open in CodeFlow

JeremyKuhne left a comment

Choose a reason for hiding this comment

JeremyKuhne left a comment

Choose a reason for hiding this comment

JeremyKuhne left a comment

Choose a reason for hiding this comment

codecov bot commented Jun 25, 2024 • edited Loading

Codecov Report

lonitra Dec 9, 2024

Choose a reason for hiding this comment

lonitra Dec 11, 2024

Choose a reason for hiding this comment

Tanya-Solyanik Dec 11, 2024

Choose a reason for hiding this comment

lonitra left a comment

Choose a reason for hiding this comment

Tanya-Solyanik commented Jun 18, 2024 •

edited

Loading

codecov bot commented Jun 25, 2024 •

edited

Loading