Home > Articles > Programming > Windows Programming

Serializing Objects to a .NET DataSet

Paul Kimmel introduces the XmlSerializer and demonstrates how to serialize everyday objects directly to an ADO.NET DataSet. Use this technique to take advantage of powerful database tools for managing data.
This article is adapted from Paul Kimmel's upcoming book, The Visual Basic .NET Developer's Book (Addison-Wesley, scheduled for publication Fall 2002, ISBN 0-672-32407-5).
Like this article? We recommend

Like this article? We recommend

Serializing Objects to a DataSet


DataSets are powerful abstractions introduced with ADO.NET that allow you to manage all kinds of data, not just database-originated data. Serializing objects to a DataSet provides me with an opportunity to introduce several technologies found in the .NET Framework. Additionally, you may find it useful to convert existing objects into a DataSet.

This article describes the XmlSerializer, XML attributes in .NET, streams, and the ADO.NET DataSet. The XmlSerializer can be used to persist and reconstitute persisted objects; in addition, it's an essential aspect of XML web services. Streams are used to manage data, including data found in files, and the ADO.NET DataSet is especially useful as a data repository for any data. Individually and combined, these technologies represent powerful .NET programming tools.

Applying XML Attributes

Extensible Markup Language (XML) is ubiquitous in .NET. Interestingly, you don't have to learn how to read XML to use XML capabilities in .NET, because .NET can read and write XML on your behalf. XML is a language that has proven useful as a means of transmitting self-describing data, composed of metacharacters and text, between computers. Due to its self-describing capabilities, XML is an especially useful kind of text to send across the Internet.

Knowing that data is moved around as XML is important. Consider the case where we have a class named Customer, containing a name, phone number, and web address. Well-named properties in C# might include Name, Phone, Website, but these might not represent good display names. We could use XML attributes to provide better display names, or use other XML attributes to indicate that we want a property to be ignored during serialization. Listing 1 demonstrates a sample Customer class that uses two of the standard XML attributes to describe how properties should be treated when serialized.

Listing 1—A Customer Class That Demonstrates the XmlElementAttribute and the XmlIgnoreAttribute

1: [Serializable]
2: public class Customer
3: {
4:  private string id;
5:  private string name;
6:  private string website;
7:  private string phone;
8:  private static int count;
10:  public Customer()
11:  {
12:   id = (count++).ToString();
13:  }
15:  public Customer(string name) : this()
16:  {
17:   this.name = name;
18:  }
20:  public Customer(string name, string website): this()
21:  {
22:   this.name = name;
23:   this.website = website;
24:  }
26:  public Customer(string name,
27:   string website, string phone): this()
28:  {
29:   this.name = name;
30:   this.website = website;
31:   this.phone = phone;
32:  }
34:  [XmlIgnore]
35:  public string Id
36:  {
37:   get{ return id;}
38:   set{ id = value; }
39:  }
41:  [XmlElement("Customer Name")]
42:  public string Name
43:  {
44:   get{ return name; }
45:   set{ name = value; }
46:  }
48:  [XmlElement("Customer Phone")]
49:  public string Phone
50:  {
51:   get{ return phone; }
52:   set{ phone = value; }
53:  }
55:  [XmlElement("URL")]
56:  public string Website
57:  {
58:   get{ return website; }
59:   set{ website = value; }
60:  }
61: }


By convention, we drop the Attribute suffix when applying an attribute. Thus, XmlIgnoreAttribute becomes XmlIgnore when applied.

Attributes are just classes. They have a unique function in that attributes allow you to convey extra information about an entity, written as metadata, which makes attributes very useful. For example, you can apply code access security declaratively by using security attributes in .NET.


Details on .NET security will be covered in my upcoming book, The Visual Basic .NET Developer's Book (Addison-Wesley, ISBN 0-672-32407-5), which is scheduled for publication Fall 2002.

Lines 34, 41, 48, and 55 of Listing 1 demonstrate XmlElementAttribute and XmlIgnoreAttribute from the System.Xml.Serialization namespace.

I said earlier that you don't need to know how to read or write XML to use XML in .NET. This is true. In fact, the Serializable attribute on line 1 tells .NET that Customer objects can be serialized. Using Reflection, the serializer simply reflects the public properties and writes them as XML. (Reflection is a technology in .NET for discovering type information.)

The XmlIgnore and XmlElement attributes simply provide additional instructions to the serializer, indicating how the properties should be serialized. XmlIgnore instructs the serializer not to serialize a property, and the XmlElement attribute enables you to specify an alternate name for the property.

The Customer class uses these elements as you might expect. Notice in Listing 1 that we want to ignore the Id property; for example, we may want to ignore database identity fields when displaying data. The XmlElement attribute is used on the Name, Phone, and Website properties to provide a better name than the property name for display purposes. Listing 2 shows a serialized array of Customer objects after the XML attributes are applied.

Listing 2—A Serialized XML Array of Customer Objects

<?xml version="1.0"?>
<ArrayOfCustomer xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  <Customer_x0020_Name>Puerto Rico Ports Authority</Customer_x0020_Name>

Note that you don't have to use XML attributes to support serialization—just the Serializable attribute. It's also worth noting that the Id wasn't serialized because we used the XmlIgnore attribute, but the phone number wasn't serialized for the simple reason that there was no data provided for that field. The serializer abbreviates the XML, ignoring null properties by default.

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.


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.


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.


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.


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


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


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.


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.


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