Sams Teach Yourself XML in 21 Days

Recommended Book

Sams Teach Yourself XML in 21 Days, 3rd Edition

Learn More Buy

Recommended Book

Recommended Book 

Sams Teach Yourself XML in 21 Days, 3rd Edition

Learn More Buy

Creating and Editing an XML Document in .NET

The .NET Framework has a great deal of XML support built in, including support for creating XML documents, and that's where you're going to start today. You'll use the tools in Microsoft Visual Studio .NET to create an XML document by using an XML schema.

To create a new project, select Visual Basic Projects in the Project Types box and Windows Application in the Templates box and then give the new project the name ch21_01, as shown in Figure 21.1.

Figure 21.1 Creating a .NET project.

Creating a New XML Document in .NET

You can create a new XML document by selecting Project, Add Item to open the Add New Item dialog box, shown in Figure 21.2. Then select the XML File template in the Templates box and name this new file ch21_01.xml, as shown in Figure 21.2.

Figure 21.2 Creating an XML file.

When you click Open, the new XML file is created and opened for editing in a Visual Studio designer (that is, an editor window), as shown in Figure 21.3.

Figure 21.3 Editing an XML file.

You'll also create an XML schema for your XML document, and to do so, again select Project, Add Item, but this time select the XML Schema item in the Templates box and name the new XML schema ch21_01Schema.xsd, as shown in Figure 21.4.

Figure 21.4 Creating an XML schema.

When you click Open, the new XML schema is created and opened for editing, as shown in Figure 21.5.

Figure 21.5 Editing an XML schema.

Creating a Simple Type in an XML Schema in .NET

How do you add types to an XML schema in Visual Studio .NET? You can simply drag types from the toolbox to the left of the XML schema onto that XML schema. For example, to create a type that will hold five-digit zip codes, you can drag simpleType from the toolbox to the XML schema. This creates a new simple type entry in the XML schema with the default name simpleType1 highlighted. You can change that name to zipcode now and press Tab to move to the next field in the entry.

In the next field, select positiveInteger as the new type from the drop-down list box. To make sure your zipcode type can take only five-digit values, press Tab to move to the next row in this new entry and select pattern from the drop-down list box. This lets you enter a regular expression of the kind you saw on Day 7, "Creating Your Own Types in XML Schemas," that you can use with XML schemas to enforce data typing. In this case, your pattern will be \d{5}, ensuring that zip code values have five digits. Press Tab one more time and enter this pattern to complete the entry, as shown in Figure 21.6.

Figure 21.6 Creating a simple type.

To see what this new simple type looks like in XML, click the XML button at the bottom of the XML schema designer, and you see the results shown in Figure 21.7.

Figure 21.7 The XML view of a simple type.

Here's what your XML schema looks like so far:

<?xml version="1.0" encoding="utf-8"?>
<xs:schema id="ch21_01Schema"
    targetNamespace="http://tempuri.org/ch21_01Schema.xsd"
    elementFormDefault="qualified" xmlns="http://tempuri.org/ch21_01Schema.xsd"
    xmlns:mstns="http://tempuri.org/ch21_01Schema.xsd"
    xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:simpleType name="zipcode">
        <xs:restriction base="xs:positiveInteger">
            <xs:pattern value="\d{5}" />
        </xs:restriction>
    </xs:simpleType>
</xs:schema>

Creating a Complex Type in an XML Schema

Now you'll put together a complex type that uses the simple zipcode type you just created. To do so, click the Schema button in the XML schema's designer to switch back to the Schema view, and drag complexType from the toolbox onto the XML schema, which opens a new complex type's entry.

Next, replace the default name complexType1, which is highlighted, with a new name, person; you'll use this to hold data about various people. Instead of selecting a data type for this new type, press Tab twice to move to the next row. Then type name to create a name field and press Tab to select the data type for this new field. Next, select the string type from the drop-down list box; as you can see in the drop-down list box, there are many different data types available here. Then create a new field named address and give it the type string.

Press Tab once more to create a new field, zip—but this time, select your new simple type, zipcode, in the drop-down list box, which produces the results shown in Figure 21.8.

Figure 21.8 Creating a complex type.

Now when you switch to the XML view, you'll see that your XML schema includes the complex type person:

<?xml version="1.0" encoding="utf-8"?>
<xs:schema id="ch21_01Schema"
    targetNamespace="http://tempuri.org/ch21_01Schema.xsd"
    elementFormDefault="qualified"
    xmlns="http://tempuri.org/ch21_01Schema.xsd"
    xmlns:mstns="http://tempuri.org/ch21_01Schema.xsd"
    xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:simpleType name="zipcode">
        <xs:restriction base="xs:positiveInteger">
            <xs:pattern value="\d{5}" />
        </xs:restriction>
    </xs:simpleType>
    <xs:complexType name="person">

           <xs:sequence>

               <xs:element name="name" type="xs:string" />

               <xs:element name="address" type="xs:string" />

               <xs:element name="zip" type="zipcode" />

           </xs:sequence>

       </xs:complexType>
</xs:schema>

To save your work so far, select File, Save All.

Creating an Element

At this point, we've created two types—a simple type named zipcode and a complex type named person. Next we'll create an XML element, named <project>, which will hold data about a project we're interested in, including a contact person and the title of the project. To create this element, drag element from the toolbox onto the XML schema and open the new element for editing.

Next, give this new element the name project and click the middle box in the second row of this element's entry. Type title in that box and press Tab to move to the third box, and then select the type string. Next, tab to the next line and type contact in that line's middle box and select the type person, as shown in Figure 21.9.

Figure 21.9 Creating an element.

Creating a Document Element

Next, we'll create a document element, <projects>, that can contain multiple <project> elements. To create the <projects> element, drag element from the toolbox to the XML schema and give this new element the name "projects".

To install the <project> element as a child element of the <projects> element, just drag the small + sign at the bottom of the <project> element (if it's a – sign, click it first to turn it into a + sign) inside the <projects> element. The results are shown in Figure 21.10. That's the way you create a document element—by dragging other elements into it. You can create the entire XML element hierarchy this way, simply by dragging elements.

Figure 21.10 Creating a document element.

Here's what the new, and final, version of your XML schema looks like:

<?xml version="1.0" encoding="utf-8"?>
<xs:schema id="ch21_01Schema"
    targetNamespace="http://tempuri.org/ch21_01Schema.xsd"
    elementFormDefault="qualified"
    xmlns="http://tempuri.org/ch21_01Schema.xsd"
    xmlns:mstns="http://tempuri.org/ch21_01Schema.xsd"
    xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:simpleType name="zipcode">
        <xs:restriction base="xs:positiveInteger">
            <xs:pattern value="\d{5}" />
        </xs:restriction>
    </xs:simpleType>
    <xs:complexType name="person">
        <xs:sequence>
            <xs:element name="name" type="xs:string" />
            <xs:element name="address" type="xs:string" />
            <xs:element name="zip" type="zipcode" />
        </xs:sequence>
    </xs:complexType>
    <xs:element name="projects">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="project">
                    <xs:complexType>
                        <xs:sequence>
                            <xs:element name="title" type="xs:string" />
                            <xs:element name="contact" type="person" />
                        </xs:sequence>
                    </xs:complexType>
                </xs:element>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
</xs:schema>

You need to save the XML schema in order to make it accessible to the XML document, so select File, Save All.

Connecting an XML Schema to an XML Document

To connect your new XML schema with your XML document, ch21_01.xml, click the ch21_01.xml tab to open this XML document. In the properties page at the lower right in Visual Studio, click the targetSchema property and select the http://tempuri.org/ch21_01Schema.xsd item in the drop-down list box to associate your new XML schema with this XML document. When you do, Visual Studio adds this XML, getting you started by creating a <projects> document element:

<?xml version="1.0" encoding="utf-8" ?>
<projects xmlns="http://tempuri.org/ch21_01Schema.xsd">

           .

           .

           .

   </projects>

Now we're ready to add some data to our XML document.

Working With XML Data

To add some data to your XML document now that you've associated your XML schema with that document, click between the <projects> and </projects> tags and type <, indicating that you want to start a new element. Doing so displays the possible options, and in this case, the only option is the <project> element, as shown in Figure 21.11.

Figure 21.11 Creating XML data.

Select the <project> element now and type > to close the element. Visual Studio adds the closing tag, so your XML now looks like this:

<?xml version="1.0" encoding="utf-8" ?>
<projects xmlns="http://tempuri.org/ch21_01Schema.xsd">
<project></project>
</projects>

That's how the editing process works—you type < when you want to be prompted with the acceptable elements, you select an element from the prompt that appears, and you type > to close the element. Using the XML editor and the prompts based on your XML schema, you now enter this XML in your document:

<?xml version="1.0" encoding="utf-8" ?>
<projects xmlns="http://tempuri.org/ch21_01Schema.xsd">
    <project>
        <title>The XML Project</title>

           <contact>

               <name>Edward Zip</name>

               <address>0 Disk Drive</address>

               <zip>10001</zip>

           </contact>
    </project>
</projects>

To validate this XML document against your XML schema, select XML, Validate XML Data. This evaluates the data you've entered, and if everything checks out against the XML schema, you'll get the message No validation errors were found. at lower left in Visual Studio .NET, as shown in Figure 21.12. If you've made a mistake—such as not entering five digits (and only five digits) for the zip code—Visual Studio .NET lets you know with error messages in the Task window.

Figure 21.12 Validating an XML document.

You have just created and validated a new XML document with an XML schema by using Visual Studio .NET.