Practical .NET

Retain State by Serializing to Disk

If you're looking for an easy way to save the user's current state, the simplest solution is use the Serialize and Deserialize method.

The reality is that users often don't complete a task without being interrupted. As a decent human being, you should allow your users to save their work so that they can continue later. You could use a database to save the user's state but often you'll want to save unstructured data: a bizarre combination of current internal variables and lists of data displayed on the screen that represent "where the user is right now."

A simple solution is to create a "state object" with whatever properties you need to hold stat data, shove the current data into those properties, and then save that object to a file on the user's disk (it is, after all, the user's data and I'd rather take advantage of the user's storage than mine). This is the code to write out your state object:

Dim so As New StateObject
...set properties on state object...
Dim str As New FileStream("c:\status\status.st", FileMode.Create, FileAccess.Write)
Dim bf = New BinaryFormatter()
bf.Serialize(str, so)

And here's the code to read it back in:

Dim str As New FileStream("c:\status\status.st",FileMode.Open, FileAccess.Read)
Dim bf = new BinaryFormatter()
Dim so As StateObject
so = DirectCast(bf.Deserialize(str), StateObject)

This code works equally well if you're writing out a List of objects as it does with a single object: Just pass the whole List to the Serialize method.

Two things to remember: You'll need add the Serializable attribute to your state object class; If the user wants to resume from another computer, they're going to be disappointed -- this only works if the user restarts on the same computer they saved their state object on.

About the Author

Peter Vogel is a system architect and principal in PH&V Information Services. PH&V provides full-stack consulting from UX design through object modeling to database design. Peter tweets about his VSM columns with the hashtag #vogelarticles. His blog posts on user experience design can be found at http://blog.learningtree.com/tag/ui/.

comments powered by Disqus

Featured

  • Compare New GitHub Copilot Free Plan for Visual Studio/VS Code to Paid Plans

    The free plan restricts the number of completions, chat requests and access to AI models, being suitable for occasional users and small projects.

  • Diving Deep into .NET MAUI

    Ever since someone figured out that fiddling bits results in source code, developers have sought one codebase for all types of apps on all platforms, with Microsoft's latest attempt to further that effort being .NET MAUI.

  • Copilot AI Boosts Abound in New VS Code v1.96

    Microsoft improved on its new "Copilot Edit" functionality in the latest release of Visual Studio Code, v1.96, its open-source based code editor that has become the most popular in the world according to many surveys.

  • AdaBoost Regression Using C#

    Dr. James McCaffrey from Microsoft Research presents a complete end-to-end demonstration of the AdaBoost.R2 algorithm for regression problems (where the goal is to predict a single numeric value). The implementation follows the original source research paper closely, so you can use it as a guide for customization for specific scenarios.

  • Versioning and Documenting ASP.NET Core Services

    Building an API with ASP.NET Core is only half the job. If your API is going to live more than one release cycle, you're going to need to version it. If you have other people building clients for it, you're going to need to document it.

Subscribe on YouTube