SoapAttributes.SoapElement Property

Gets or sets a SoapElementAttribute to override.

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

public SoapElementAttribute SoapElement { get; set; }
/** @property */
public SoapElementAttribute get_SoapElement ()

/** @property */
public void set_SoapElement (SoapElementAttribute value)

public function get SoapElement () : SoapElementAttribute

public function set SoapElement (value : SoapElementAttribute)

Property Value

The SoapElementAttribute to override.

The SoapElementAttribute is used to control the serialization of a class member as an XML element. Set the SoapElement property to a new SoapElementAttribute to override the serialization of a class member as an XML element by creating a new SoapElementAttribute and assigning it to the property. Then add the SoapAttributes to a SoapAttributeOverrides. Create an XmlTypeMapping with the SoapAttributeOverrides, then construct an XmlSerializer with the XmlTypeMapping.

For more information, see the SoapAttributeOverrides class overview.

The following example serializes a class named Transportation. The serialization of the Vehicle field is overridden. In the CreateOverrideSerializer method, a SoapAttributeOverrides is created, and for each overridden member or enumeration, a SoapAttributes is created with the appropriate property set and added to the SoapAttributeOverrides. An XmlTypeMapping is created using the SoapAttributeOverrides, and that XmlTypeMapping is used to create the XmlSerializer that overrides the default serialization.

using System;
using System.IO;
using System.Xml.Serialization;
using System.Collections;
using System.Xml;
using System.Text;
public class Transportation
{
   // The SoapElementAttribute specifies that the
   // generated XML element name will be "Wheels"
   // instead of "Vehicle".
   [SoapElement("Wheels")]
   public string Vehicle;
   [SoapElement(DataType = "dateTime")]
   public DateTime CreationDate;
   [SoapElement(IsNullable = true)]
   public Thing thing;
   
}

public class Thing{ 
   [SoapElement(IsNullable=true)] public string ThingName;
}

public class Test
{
   public static void Main()
   {
      Test t = new Test();
      t.SerializeObject("SoapElementOriginal.xml");
      t.SerializeOverride("SoapElementOverride.xml");
      Console.WriteLine("Finished writing two XML files.");
   }

   // 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.SoapElement= soapElement1;

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

   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.Now;
      myTransportation.thing = new Thing();

      XmlTextWriter writer = 
      new XmlTextWriter(filename, Encoding.UTF8);
      writer.Formatting = Formatting.Indented;
      writer.WriteStartElement("wrapper");
      ser.Serialize(writer, myTransportation);
      writer.WriteEndElement();
      writer.Close();
   }
   public void SerializeObject(string filename){
      // Create an XmlSerializer instance.
      XmlSerializer ser = new XmlSerializer(typeof(Transportation));
      Transportation myTransportation = 
      new Transportation();
      myTransportation.Vehicle = "MyCar";
      myTransportation.CreationDate = DateTime.Now;
      myTransportation.thing = new Thing();
      XmlTextWriter writer = 
      new XmlTextWriter(filename, Encoding.UTF8);
      writer.Formatting = Formatting.Indented;
      writer.WriteStartElement("wrapper");
      ser.Serialize(writer, myTransportation);
      writer.WriteEndElement();
      writer.Close();
   }
}

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

Windows 98, Windows 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 .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0
Show: