{"id":1697,"date":"2014-04-18T07:28:24","date_gmt":"2014-04-18T07:28:24","guid":{"rendered":"http:\/\/putridparrot.com\/blog\/?p=1697"},"modified":"2014-04-18T07:28:24","modified_gmt":"2014-04-18T07:28:24","slug":"generating-classes-from-xml-using-xsd-exe","status":"publish","type":"post","link":"https:\/\/putridparrot.com\/blog\/generating-classes-from-xml-using-xsd-exe\/","title":{"rendered":"Generating classes from XML using xsd.exe"},"content":{"rendered":"

The XML Schema Definition Tool<\/a> (xsd.exe) can be used to generate xml schema files from XML and better still C# classes from xml schema files.<\/p>\n

Creating classes based upon an XML schema file<\/strong><\/p>\n

So in it’s simplest usage we can simply type<\/p>\n

\r\nxsd person.xsd \/classes\r\n<\/pre>\n
and this generates C# classes representing the xml schema. The default output is C# but using the \/language<\/em> or the shorter form \/l<\/em> switch we can generate Visual Basic using the VB value, JScript using JS or CS if we wanted to explicitly static the language was to be C#. So for example using the previous command line but now to generate VB code we can write<\/p>\n
\r\nxsd person.xsd \/classes \/l:VB\r\n<\/pre>\n
Assuming we have an xml schema, person.xsd, which looks like this<\/p>\n
\r\n<?xml version="1.0" encoding="utf-8"?>\r\n<xs:schema elementFormDefault="qualified" xmlns:xs="http:\/\/www.w3.org\/2001\/XMLSchema">\r\n  <xs:element name="Person" nillable="true" type="Person" \/>\r\n  <xs:complexType name="Person">\r\n    <xs:sequence>\r\n      <xs:element minOccurs="0" maxOccurs="1" name="FirstName" type="xs:string" \/>\r\n      <xs:element minOccurs="0" maxOccurs="1" name="LastName" type="xs:string" \/>\r\n      <xs:element minOccurs="1" maxOccurs="1" name="Age" type="xs:int" \/>\r\n    <\/xs:sequence>\r\n  <\/xs:complexType>\r\n<\/xs:schema>\r\n<\/pre>\n
The class created (in C#) looks like the following (comments removed)<\/p>\n
\r\n[System.CodeDom.Compiler.GeneratedCodeAttribute("xsd", "4.0.30319.17929")]\r\n[System.SerializableAttribute()]\r\n[System.Diagnostics.DebuggerStepThroughAttribute()]\r\n[System.ComponentModel.DesignerCategoryAttribute("code")]\r\n[System.Xml.Serialization.XmlRootAttribute(Namespace="", IsNullable=true)]\r\npublic partial class Person {\r\n    \r\n    private string firstNameField;\r\n    \r\n    private string lastNameField;\r\n    \r\n    private int ageField;\r\n    \r\n    public string FirstName {\r\n        get {\r\n            return this.firstNameField;\r\n        }\r\n        set {\r\n            this.firstNameField = value;\r\n        }\r\n    }\r\n    \r\n    public string LastName {\r\n        get {\r\n            return this.lastNameField;\r\n        }\r\n        set {\r\n            this.lastNameField = value;\r\n        }\r\n    }\r\n    \r\n    public int Age {\r\n        get {\r\n            return this.ageField;\r\n        }\r\n        set {\r\n            this.ageField = value;\r\n        }\r\n    }\r\n}\r\n<\/pre>\n
Creating an XML schema based on an XML file<\/strong><\/p>\n
It might be that we’ve got an XML file but no xml schema, so we’ll need to convert that to an xml schema before we can generate our classes file. Again we can use xsd.exe<\/p>\n
\r\nxsd person.xml\r\n<\/pre>\n
the above will create an xml schema based upon the XML file, obviously this is limited to what is available in the XML file itself, so if your XML doesn’t have “optional” elements\/attributes xsd.exe obviously cannot include those in the schema it produces.<\/p>\n
Assuming we therefore started with an XML file, the person.xml, which looks like the following<\/p>\n
\r\n<?xml version="1.0" encoding="utf-8"?>\r\n\r\n<Person>\r\n   <FirstName>Spoungebob<\/FirstName>\r\n   <LastName>Squarepants<\/LastName>\r\n   <Age>21<\/Age>\r\n<\/Person>\r\n<\/pre>\n
Note: I’ve no idea if that is really SpongeBob’s age.<\/em><\/p>\n
Running xsd.exe against person.xml file we get the following xsd schema<\/p>\n
\r\n<?xml version="1.0" encoding="utf-8"?>\r\n<xs:schema id="NewDataSet" xmlns="" xmlns:xs="http:\/\/www.w3.org\/2001\/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">\r\n  <xs:element name="Person">\r\n    <xs:complexType>\r\n      <xs:sequence>\r\n        <xs:element name="FirstName" type="xs:string" minOccurs="0" \/>\r\n        <xs:element name="LastName" type="xs:string" minOccurs="0" \/>\r\n        <xs:element name="Age" type="xs:string" minOccurs="0" \/>\r\n      <\/xs:sequence>\r\n    <\/xs:complexType>\r\n  <\/xs:element>\r\n  <xs:element name="NewDataSet" msdata:IsDataSet="true" msdata:UseCurrentLocale="true">\r\n    <xs:complexType>\r\n      <xs:choice minOccurs="0" maxOccurs="unbounded">\r\n        <xs:element ref="Person" \/>\r\n      <\/xs:choice>\r\n    <\/xs:complexType>\r\n  <\/xs:element>\r\n<\/xs:schema>\r\n<\/pre>\n
From this we could now create our classes as previously outlined.<\/p>\n
Creating an xml schema based on .NET type<\/strong><\/p>\n
What if we’ve got a class\/type and we want to serialize it as XML, let’s use xsd.exe to create the XML schema for us.<\/p>\n
If the class looks like the following<\/p>\n
\r\npublic class Person\r\n{\r\n   public string FirstName { get; set; }\r\n   public string LastName { get; set; }\r\n   public int Age { get; set; }\r\n}\r\n[code]\r\n\r\n<em>Note: Assuming the class is compiled into an assembly call DomainObjects.dll<\/em>\r\n\r\nThen running xsd.exe with the following command line\r\n\r\n[code language="xml"]\r\nxsd.exe DomainObjects.dll \/type:Person\r\n<\/pre>\n
will then generate the following xml schema<\/p>\n
\r\n<?xml version="1.0" encoding="utf-8"?>\r\n<xs:schema elementFormDefault="qualified" xmlns:xs="http:\/\/www.w3.org\/2001\/XMLSchema">\r\n  <xs:element name="Person" nillable="true" type="Person" \/>\r\n  <xs:complexType name="Person">\r\n    <xs:sequence>\r\n      <xs:element minOccurs="0" maxOccurs="1" name="FirstName" type="xs:string" \/>\r\n      <xs:element minOccurs="0" maxOccurs="1" name="LastName" type="xs:string" \/>\r\n      <xs:element minOccurs="1" maxOccurs="1" name="Age" type="xs:int" \/>\r\n    <\/xs:sequence>\r\n  <\/xs:complexType>\r\n<\/xs:schema>\r\n<\/pre>\n
You’ll notice this is slightly different from the code generated from the person.xml file. <\/p>\n","protected":false},"excerpt":{"rendered":"
The XML Schema Definition Tool (xsd.exe) can be used to generate xml schema files from XML and better still C# classes from xml schema files. Creating classes based upon an XML schema file So in it’s simplest usage we can simply type xsd person.xsd \/classes and this generates C# classes representing the xml schema. The […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_jetpack_memberships_contains_paid_content":false,"footnotes":""},"categories":[3,70],"tags":[],"class_list":["post-1697","post","type-post","status-publish","format-standard","hentry","category-c","category-xml"],"jetpack_sharing_enabled":true,"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts\/1697","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/comments?post=1697"}],"version-history":[{"count":18,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts\/1697\/revisions"}],"predecessor-version":[{"id":1716,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts\/1697\/revisions\/1716"}],"wp:attachment":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/media?parent=1697"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/categories?post=1697"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/tags?post=1697"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}