Home > Articles > Programming > Windows Programming

Persisting Your Visual Basic .NET Objects with .NET Serialization

  • Print
  • + Share This
The .NET Framework provides classes that let you save your objects to a file easily. This feature, called serialization, lets you create your own file formats. Jeff Cogswell shows you how to get the most out of the .NET serialization features.
Like this article? We recommend

If you're developing a standalone .NET application, more than likely you'll need to provide your users with the ability to save and later load data. There are many ways to approach such a task. The wrong way to do it is to open a binary file and write the individual data strings and numbers out to the stream, passing each data item in a particular order, and rebuilding everything on the way back in. The correct — and much easier — way is to use the .NET Framework's set of classes that make saving your data far easier. Such a process is called serialization, and the data is said to be serialized. The serialization classes make saving your data so easy it's almost trivial. I'm not kidding. And that's the way it should be. If you're writing a program that models molecules, for example, your job should be focusing on the molecular modeling, not figuring out a way to save data to a file.

In this article, I'll show you how to serialize the data, diving in with a set of complex data just to show you how easy it really is. Then I'll show you some ways to extend the concept to support different types of data, as well as versioning.

Saving the Data

Before we get started, we need some data to save. Rather than trying to build an entire molecular modeling program, I’ll use an example from a recent test program I was building that renders text and fonts, letting the user customize everything. Here’s the user data that needs to be saved:

  • Current font. This is an instance of the class System.Drawing.Font.
  • Rendering hint. This is an enumeration of type System.Drawing.Text.TextRenderingHint and deals with anti-aliasing and smoothing.
  • Font color and background color. Both are instances of the class System.Drawing.Color.
  • Contrast. This is an integer used in the text rendering.
  • Text to be rendered. This is a string.

Sometimes programmers lose sight of the concept, but it’s true for most programs: Software is about modifying data. When you’re using a word processing program, you’re modifying a set of data that consists of the text you’re typing along with font and layout information. Regardless of the software, if you think of the user data as a single entity or collection, serializing becomes easier. In our case, that means lumping all the previous data into a single class. Here’s what our class will look like:

<Serializable()> Class TextSettings
  Public CurrentFont As Font
  Public CurrentHint As TextRenderingHint
  Public FontColor As Color = Color.Black
  Public BackgroundColor As Color = Color.LightGray
  Public Contrast As Int32 = 0
  Public Text As String = ""
End Class

For this example, I made the members public. In a more realistic case, you would use properties and various protected members and such, along with member subroutines and functions, to manipulate the data.

For the class to be serializable, you need to add a .NET attribute. That’s the <Serializable()> at the beginning of the class declaration. An attribute is simply an additional class associated with the object. In this case, the additional class is called Serializable, and we call the class the Serializable attribute. Each instance of our class TextSettings has an instance of Serializable associated with it. To use the serialization features of .NET, you need to make a class serializable by adding the Serializable attribute.

The next step is to add the code to save the data. You would use this code either as a button handler or as a menu handler. My program had a toolbar and no menu. Here’s the code I used, which handles the click of the Save button:

Private Sub SaveToolStripButton_Click(ByVal sender As System.Object, _
ByVal e As System.EventArgs) Handles SaveToolStripButton.Click
  If SaveFileDialog1.ShowDialog = Windows.Forms.DialogResult.OK Then
    Dim formatter As New _
      Runtime.Serialization.Formatters.Binary.BinaryFormatter
    Dim stream As New FileStream(SaveFileDialog1.FileName, _
      FileMode.Create, FileAccess.Write, FileShare.None)
    formatter.Serialize(stream, TextValues)
    stream.Close()
  End If
End Sub

To use this code, you’ll need an Imports System.IO line at the top of the code file. Then, believe it or not, you have everything you need to save your data. This code opens a SaveFileDialog dialog box so the user can choose the filename and directory for the data file. If the user clicks OK, the code inside the If block runs.

The If block creates a new instance of the class called BinaryFormatter. Then the code creates a new file stream using the filename that the user chose. Next, the code calls the Serialize method of BinaryFormatter, passing the stream and the instance of the data. (TextValues is an instance of our data class, TextSettings). Finally, the code closes the stream.

That’s it! That’s all it takes! It couldn’t be easier. Nowhere did I have to write out the individual members manually; I didn’t even refer to the individual members in the code.

Now I’ll show you the code for reading the data.

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020