Skip to content

Latest commit

 

History

History
75 lines (48 loc) · 5.58 KB

winforms.md

File metadata and controls

75 lines (48 loc) · 5.58 KB

Windows Forms in .NET 10 Preview 1 - Release Notes

WinForms continues to ease the pain of migrating away from BinaryFormatter in .NET 10 Preview 1 by simplifying Clipboard serialization for certain custom types. In .NET 9, calls to BinaryFormatter to perform serialization were updated to throw PlatformNotSupportedException if the developer did not reference an unsupported compatibility package and enable BinaryFormatter via an application configuration switch (see more). Clipboard and Drag/Drop scenarios which use custom types, as of .NET 9, require the developer to either enable BinaryFormatter or explicitly take action to use JSON serialization (or similar) to succeed. For additional details about migrating WinForms application away from BinaryFormatter see the Windows Forms migration guide for BinaryFormatter. In .NET 10 Preview 1 WinForms is adding several APIs to enable developers to more easily use JSON serliaization in while using the Clipboard. Additionally, developers can now more easily specify expected types when getting data from the Clipboard.

For in-depth discussion of the APIs involved, and usage examples, please see the original API Proposal in the WinForms repo.

Obsoleted APIs

In .NET 10, WinForms has marked as obsolete the following APIs to help warn developers that BinaryFormatter may be used to deserialize data.

Clipboard:

  • public static object? GetData(string format)

DataObject:

  • public virtual object? GetData(string format)
  • public virtual object? GetData(string format, bool autoConvert)
  • public virtual object? GetData(Type format)

ClipboardProxy (VisualBasic wrapper for WinForms Clipboard):

  • public object GetData(string format)

New APIs

We’ve introduced the following APIs in Windows Forms for .NET 10 Preview 1:

Clipboard:

  • public static void SetDataAsJson<T>(string format, T data)
  • public static bool TryGetData<T>(string format, out T data)
  • public static bool TryGetData<T>(string format, Func<Reflection.Metadata.TypeName, Type> resolver, out T data)

DataObject:

  • public void SetDataAsJson<T>(T data)
  • public void SetDataAsJson<T>(string format, T data)
  • public void SetDataAsJson<T>(string format, bool autoConvert, T data)
  • public bool TryGetData<T>(out T data);
  • public bool TryGetData<T>(string format, out T data);
  • public bool TryGetData<T>(string format, bool autoConvert, out T data);
  • public bool TryGetData<T>(string format, Func<Reflection.Metadata.TypeName, Type> resolver, bool autoConvert, out T data);
  • protected virtual bool TryGetDataCore<T>(string format, Func<Reflection.Metadata.TypeName, Type> resolver, bool autoConvert, out T data)

ITypedDataObject:

  • public bool TryGetData<T>(out T data);
  • public bool TryGetData<T>(string format, out T data);
  • public bool TryGetData<T>(string format, bool autoConvert, out T data);
  • public bool TryGetData<T>(string format, Func<Reflection.Metadata.TypeName, Type> resolver, bool autoConvert, out T data);

DataObjectExtensions:

  • public static bool TryGetData<T>(this IDataObject dataObject, out T data)
  • public static bool TryGetData<T>(this IDataObject dataObject, string format, out T data)
  • public static bool TryGetData<T>(this IDataObject dataObject, string format, bool autoConvert, out T data)
  • public static bool TryGetData<T>(this IDataObject dataObject, string format, Func<Reflection.Metadata.TypeName, Type> resolver, bool autoConvert, out T data)

ClipboardProxy:

  • public void SetDataAsJson<T>(T data)
  • public void SetDataAsJson<T>(string format, T data)
  • public bool TryGetData<T>(string format, out T data)
  • public bool TryGetData<T>(string format, System.Func<System.Reflection.Metadata.TypeName, System.Type> resolver, out T data)

New Configuration Switch

If an application is unable to adopt the new APIs, and requires a fallback to BinaryFormatter serialization during Clipboard and Drag/Drop operations, the developer will need to take additional action. In .NET 9, calls to BinaryFormatter will always throw a PlatformNotSupportedException unless the developer follows the instructions located here: BinaryFormatter compatibility package . In .NET 10 Preview 1, WinForms will also by default disable the use of BinaryFormatter at the application level using the same compatibility switches. Additionally, we allow developer to control BinaryFormatter usage in Clipboard only with a new compatibility switch Windows.ClipboardDragDrop.EnableUnsafeBinaryFormatterSerialization. For full compatibility application should reference the unsupported compatibility package and opt in to both configuration switches.

Windows Forms updates in .NET 10:

AI-assisted content. This article was partially created with the help of AI. An author reviewed and revised the content as needed. Learn moreAI-assisted content. This article was partially created with the help of AI. An author reviewed and revised the content as needed. Learn more