BinaryFormatter Migration Guide

[adamsitnik]

This PR will capture the initial publication of the BinaryFormatter Migration Guide, to be published before the release of .NET 9 Preview 7. The BinaryFormatter implementation was removed from the shared framework in .NET 9 Preview 6. The Migration Guide is intended to serve customers who are either surprised by this change or who have been aware the change was coming but now need to react to it.

The guide includes several sections and pages, with the following list tracking who is contributing each of the sections/pages. As pages are completed in this PR, we will check off the boxes in the list to indicate readiness for this PR to be merged.

• Overview (@terrajobst)
• Choose a serializer (@adamsitnik)
  • Migrate to System.Text.Json [JSON] (@adamsitnik)
  • Migrate to DataContractSerializer [XML] (@adamsitnik)
  • Migrate to MessagePack [binary] (@adamsitnik)
  • Migrate to protobuf-net [binary] (@adamsitnik)
  • Read NRBF Payloads (@adamsitnik)
• Compatibility Package (@terrajobst)
• WinForms Applications (@JeremyKuhne, @lonitra)
• WPF Applications (@rchauhan18, @Kuldeep-MS )
• Clipboard and Drag & Drop scenarios (@JeremyKuhne, @lonitra)
• BinaryFormatter functionality reference (@adamsitnik)

Outstanding feedback/comments (as of Aug 6 @ 11:30pm PT):

index.md

• Jeremy/Adam: "I don't understand the mandatory type list and hydration comments" - BinaryFormatter Migration Guide #41564 (comment)

functionality-reference.md

• Jeremy/Adam: "What I want to express is: using SerializationBinder is good..." - BinaryFormatter Migration Guide #41564 (comment)

winforms-applications.md

• (idea for the future) Klaus/Loni/Tanya: "SizeF type converter..." - BinaryFormatter Migration Guide #41564 (comment)
• (FYI discussion) Klaus/Loni/Tanya: "BitMaps/Images/SVG data..." - BinaryFormatter Migration Guide #41564 (comment)
• (idea for the future) Klaus/Loni: "Extension methods maybe for converting BitMaps..." - BinaryFormatter Migration Guide #41564 (comment)
• (implementation discussion) Klaus/Loni/Tanya: "SizeF type converter..." - BinaryFormatter Migration Guide #41564 (comment)
• (implementation discussion) Klaus/Loni/Tanya: "Image is the same as Bitmap... MetaDataFiles had never been supported..." - BinaryFormatter Migration Guide #41564 (comment)
• Tanya/Loni: "Property type does not have a DesignTime serializer" - BinaryFormatter Migration Guide #41564 (comment)
• Tanya/Loni: "Add a screen shot... analyzer?" - BinaryFormatter Migration Guide #41564 (comment)
• Jeff/Jeremy K/Loni: Jeff applied his own feedback to winforms-applications.md - BinaryFormatter Migration Guide #41564 (comment)

winforms-wpf-ole-guidance.md

• Genevieve/Loni: "Is this still in progress?" - BinaryFormatter Migration Guide #41564 (comment)
• Tanya: "It does not have to be a UserControl..." - BinaryFormatter Migration Guide #41564 (comment)

wpf-applications.md

• Loni/Rishabh: "Write out Windows Presentation Foundation..." - BinaryFormatter Migration Guide #41564 (comment)
• Loni/Rishabh: "Clipboard section..." - BinaryFormatter Migration Guide #41564 (comment)
• Loni/Rishabh: "user action that triggers the call to load/save?" - BinaryFormatter Migration Guide #41564 (comment)
• Jeff/Rishabh: Jeff applied his own feedback to wpf-applications.md - BinaryFormatter Migration Guide #41564 (comment)
• Jeff/Rishabh: "Avalon Binding" - BinaryFormatter Migration Guide #41564 (comment)

choose-a-serializer.md

• Jeff to get Matt Connew's review - BinaryFormatter Migration Guide #41564 (comment)
• Immo/Genevieve: Titles in active voice? - BinaryFormatter Migration Guide #41564 (comment)

read-nrbf-payloads.md

• Immo/Jeff/Adam: "FormatterTypeStyle.TypeAlways..." - BinaryFormatter Migration Guide #41564 (comment)

To be addressed in a follow-up PR:

1. Guidance for [Serializable] attribute (to be assigned)
2. Exception serialization (@adamsitnik)

---

Internal previews

Toggle expand/collapse

📄 File	🔗 Preview link
docs/standard/serialization/binaryformatter-migration-guide/choose-a-serializer.md	docs/standard/serialization/binaryformatter-migration-guide/choose-a-serializer
docs/standard/serialization/binaryformatter-migration-guide/compatibility-package.md	docs/standard/serialization/binaryformatter-migration-guide/compatibility-package
docs/standard/serialization/binaryformatter-migration-guide/functionality-reference.md	docs/standard/serialization/binaryformatter-migration-guide/functionality-reference
docs/standard/serialization/binaryformatter-migration-guide/index.md	docs/standard/serialization/binaryformatter-migration-guide/index
docs/standard/serialization/binaryformatter-migration-guide/migrate-to-datacontractserializer.md	docs/standard/serialization/binaryformatter-migration-guide/migrate-to-datacontractserializer
docs/standard/serialization/binaryformatter-migration-guide/migrate-to-messagepack.md	docs/standard/serialization/binaryformatter-migration-guide/migrate-to-messagepack
docs/standard/serialization/binaryformatter-migration-guide/migrate-to-protobuf-net.md	docs/standard/serialization/binaryformatter-migration-guide/migrate-to-protobuf-net
docs/standard/serialization/binaryformatter-migration-guide/migrate-to-system-text-json.md	docs/standard/serialization/binaryformatter-migration-guide/migrate-to-system-text-json
docs/standard/serialization/binaryformatter-migration-guide/read-nrbf-payloads.md	docs/standard/serialization/binaryformatter-migration-guide/read-nrbf-payloads
docs/standard/serialization/binaryformatter-migration-guide/winforms-applications.md	docs/standard/serialization/binaryformatter-migration-guide/winforms-applications
docs/standard/serialization/binaryformatter-migration-guide/winforms-wpf-ole-guidance.md	docs/standard/serialization/binaryformatter-migration-guide/winforms-wpf-ole-guidance
docs/standard/serialization/binaryformatter-migration-guide/wpf-applications.md	docs/standard/serialization/binaryformatter-migration-guide/wpf-applications
docs/standard/serialization/binaryformatter-security-guide.md	docs/standard/serialization/binaryformatter-security-guide

[bartonjs]

Out of time for today

[adamsitnik]

@gewarren big thanks for a very detailed review!