Export (0) Print
Expand All

XmlTypeMapping Class

Contains a mapping of one type to another.

Namespace: System.Xml.Serialization
Assembly: System.Xml (in system.xml.dll)

'Declaration
Public Class XmlTypeMapping
	Inherits XmlMapping
'Usage
Dim instance As XmlTypeMapping

public class XmlTypeMapping extends XmlMapping
public class XmlTypeMapping extends XmlMapping
Not applicable.

The XmlTypeMapping class is used to serialize an object as encoded SOAP XML. The resulting XML conforms to section 5 of the World Wide Web Consortium (www.w3.org) document, "Simple Object Access Protocol (SOAP) 1.1". Create an XmlTypeMapping by calling the ImportTypeMapping method of the SoapReflectionImporter class. Use the XmlTypeMapping to construct an instance of the XmlSerializer class. To control the serialization, use one of the attributes listed in Attributes That Control Encoded SOAP Serialization.

The following example serializes an instance of a class named Transportation that contains a field named Vehicle. A SoapElementAttribute is applied to the field. When the field is serialized, the XML element name is "Wheels" instead of "Vehicle". The SerializeOverride method creates a SoapElementAttribute and sets the SoapElement property of a SoapAttributes to the SoapElementAttribute. The SoapAttributes is added to a SoapAttributeOverrides that is used to create an XmlTypeMapping. An XmlSerializer is constructed with the XmlTypeMapping, and an instance of the Transportation class is again serialized. Because the SoapElementAttribute is used to override the serialization, the generated XML element name is now "Truck" instead of "Wheels".

Imports System
Imports System.IO
Imports System.Xml.Serialization
Imports System.Collections
Imports System.Xml
Imports System.Text
Public Class Transportation
   ' The SoapElementAttribute specifies that the
   ' generated XML element name will be "Wheels"
   ' instead of "Vehicle".
   <SoapElement("Wheels")> Public Vehicle As String 
   <SoapElement(DataType:= "dateTime")> _
   public CreationDate As DateTime    
   <SoapElement(IsNullable:= true)> _
   public thing As Thing
End Class

Public Class Thing
   <SoapElement(IsNullable:=true)> public ThingName As string 
End Class

Public Class Test

   Shared Sub Main()
      Dim t As Test = New Test()
      t.SerializeObject("SoapElementOriginalVb.xml")
      t.SerializeOverride("SoapElementOverrideVb.xml")
      Console.WriteLine("Finished writing two XML files.")
   End Sub

   ' Return an XmlSerializer used for overriding.
   Public Function CreateSoapOverrider() As XmlSerializer 
      ' Create the SoapAttributes and SoapAttributeOverrides objects.
      Dim soapAttrs As SoapAttributes = New SoapAttributes()

      Dim soapOverrides As SoapAttributeOverrides = _
      New SoapAttributeOverrides()
            
      ' Create a SoapElementAttribute to override 
      ' the Vehicles property. 
      Dim soapElement1 As SoapElementAttribute = _
      New SoapElementAttribute("Truck")
      ' Set the SoapElement to the object.
      soapAttrs.SoapElement= soapElement1

      ' Add the SoapAttributes to the SoapAttributeOverrides,
      ' specifying the member to override. 
      soapOverrides.Add(GetType(Transportation), "Vehicle", soapAttrs)
      
      ' Create the XmlSerializer, and return it.
      Dim myTypeMapping As XmlTypeMapping = (New _
      SoapReflectionImporter (soapOverrides)).ImportTypeMapping _
      (GetType(Transportation))
      return New XmlSerializer(myTypeMapping)
   End Function

   Public Sub SerializeOverride(filename As String)
      ' Create an XmlSerializer instance.
      Dim ser As XmlSerializer = CreateSoapOverrider()

      ' Create the object and serialize it.
      Dim myTransportation As Transportation = _
      New Transportation()

      myTransportation.Vehicle = "MyCar"
      myTransportation.CreationDate = DateTime.Now
      myTransportation.thing= new Thing()
      
      Dim writer As XmlTextWriter = _
      New XmlTextWriter(filename, Encoding.UTF8)
      writer.Formatting = Formatting.Indented
      writer.WriteStartElement("wrapper")
      ser.Serialize(writer, myTransportation)
      writer.WriteEndElement()
      writer.Close()
   End Sub

   Public Sub SerializeObject(filename As String)
      ' Create an XmlSerializer instance.
      Dim ser As XmlSerializer = _
      New XmlSerializer(GetType(Transportation))
      
      Dim myTransportation As Transportation = _
      New Transportation()
      
      myTransportation.Vehicle = "MyCar"
      myTransportation.CreationDate=DateTime.Now
      myTransportation.thing= new Thing()

      Dim writer As XmlTextWriter = _
      new XmlTextWriter(filename, Encoding.UTF8)
      writer.Formatting = Formatting.Indented
      writer.WriteStartElement("wrapper")
      ser.Serialize(writer, myTransportation)
      writer.WriteEndElement()
      writer.Close()
   End Sub
End Class

import System.*;
import System.IO.*;
import System.Xml.Serialization.*;
import System.Collections.*;
import System.Xml.*;
import System.Text.*;

public class Transportation
{
    // The SoapElementAttribute specifies that the
    // generated XML element name will be "Wheels"
    // instead of "Vehicle".
    /** @attribute SoapElement("Wheels")
     */
    public String vehicle;
    /** @attribute SoapElement(DataType = "dateTime")
     */
    public DateTime creationDate;
    /** @attribute SoapElement(IsNullable = true)
     */
    public Thing thing;
} //Transportation

public class Thing
{
    /** @attribute SoapElement(IsNullable = true)
     */
    public String thingName;
} //Thing

public class Test
{
    public static void main(String[] args)
    {
        Test t = new Test();
        t.SerializeObject("SoapElementOriginal.xml");
        t.SerializeOverride("SoapElementOverride.xml");
        Console.WriteLine("Finished writing two XML files.");
    } //main

    // Return an XmlSerializer used for overriding.
    public XmlSerializer CreateSoapOverrider()
    {
        // Create the SoapAttributes and SoapAttributeOverrides objects.
        SoapAttributes soapAttrs = new SoapAttributes();
        SoapAttributeOverrides soapOverrides = new SoapAttributeOverrides();

        /*  Create an SoapElementAttribute to override 
            the vehicles property. */
        SoapElementAttribute soapElement1 = new SoapElementAttribute("Truck");
        // Set the SoapElement to the object.
        soapAttrs.set_SoapElement(soapElement1);

        /*  Add the SoapAttributes to the SoapAttributeOverrides,
            specifying the member to override. */
        soapOverrides.Add(Transportation.class.ToType(), "Vehicle", soapAttrs);
        // Create the XmlSerializer, and return it.
        XmlTypeMapping myTypeMapping 
            = (new SoapReflectionImporter(soapOverrides)).
            ImportTypeMapping(Transportation.class.ToType());
        return new XmlSerializer(myTypeMapping);
    } //CreateSoapOverrider

    public void SerializeOverride(String fileName)
    {
        // Create an XmlSerializer instance.
        XmlSerializer ser = CreateSoapOverrider();
        // Create the object and serialize it.
        Transportation myTransportation = new Transportation();

        myTransportation.vehicle = "MyCar";
        myTransportation.creationDate = DateTime.get_Now();
        myTransportation.thing = new Thing();

        XmlTextWriter writer = new XmlTextWriter(fileName, 
            Encoding.get_UTF8());
        writer.set_Formatting(Formatting.Indented);
        writer.WriteStartElement("wrapper");
        ser.Serialize(writer, myTransportation);
        writer.WriteEndElement();
        writer.Close();
    } //SerializeOverride

    public void SerializeObject(String fileName)
    {
        // Create an XmlSerializer instance.
        XmlSerializer ser = new XmlSerializer(Transportation.class.ToType());
        Transportation myTransportation = new Transportation();
        myTransportation.vehicle = "MyCar";
        myTransportation.creationDate = DateTime.get_Now();
        myTransportation.thing = new Thing();
        XmlTextWriter writer = new XmlTextWriter(fileName, Encoding.get_UTF8());
        writer.set_Formatting(Formatting.Indented);
        writer.WriteStartElement("wrapper");
        ser.Serialize(writer, myTransportation);
        writer.WriteEndElement();
        writer.Close();
    } //SerializeObject
} //Test

System.Object
   System.Xml.Serialization.XmlMapping
    System.Xml.Serialization.XmlTypeMapping

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0

XNA Framework

Supported in: 1.0

Community Additions

ADD
Show:
© 2014 Microsoft