Export (0) Print
Expand All

XmlAttributes.XmlType Property

Gets or sets an object that specifies how the XmlSerializer serializes a class to which the XmlTypeAttribute has been applied.

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

public:
property XmlTypeAttribute^ XmlType {
	XmlTypeAttribute^ get ();
	void set (XmlTypeAttribute^ value);
}
/** @property */
public XmlTypeAttribute get_XmlType ()

/** @property */
public void set_XmlType (XmlTypeAttribute value)

public function get XmlType () : XmlTypeAttribute

public function set XmlType (value : XmlTypeAttribute)

Not applicable.

Property Value

An XmlTypeAttribute that overrides an XmlTypeAttribute applied to a class declaration.

The XmlTypeAttribute can be used to control how a type is serialized by the XmlSerializer. For example, by default, when a type is serialized, the XmlSerializer uses the class name as the XML element name. By creating an XmlTypeAttribute, setting the XmlType property to it, and creating an XmlAttributeOverrides object, you can change the XML element name.

The following example creates an XmlTypeAttribute object, and assigns it to the XmlType property of an XmlAttributes object.

#using <System.Xml.dll>
#using <System.dll>

using namespace System;
using namespace System::IO;
using namespace System::Xml::Serialization;
public ref class Car
{
public:
   int ID;
};

public ref class Transportation
{
public:
   array<Car^>^Cars;
};

// Return an XmlSerializer used for overriding.
XmlSerializer^ CreateOverrider()
{
   // Create the XmlAttributes and XmlAttributeOverrides objects.
   XmlAttributes^ attrs = gcnew XmlAttributes;
   XmlAttributeOverrides^ xOver = gcnew XmlAttributeOverrides;

   /* Create an XmlTypeAttribute and change the name of the 
      XML type. */
   XmlTypeAttribute^ xType = gcnew XmlTypeAttribute;
   xType->TypeName = "Autos";

   // Set the XmlTypeAttribute to the XmlType property.
   attrs->XmlType = xType;

   /* Add the XmlAttributes to the XmlAttributeOverrides,
      specifying the member to override. */
   xOver->Add( Car::typeid, attrs );

   // Create the XmlSerializer, and return it.
   XmlSerializer^ xSer = gcnew XmlSerializer( Transportation::typeid,xOver );
   return xSer;
}

void SerializeObject( String^ filename )
{
   // Create an XmlSerializer instance.
   XmlSerializer^ xSer = CreateOverrider();

   // Create object and serialize it.
   Transportation^ myTransportation = gcnew Transportation;
   Car^ c1 = gcnew Car;
   c1->ID = 12;
   Car^ c2 = gcnew Car;
   c2->ID = 44;
   array<Car^>^temp0 = {c1,c2};
   myTransportation->Cars = temp0;

   // To write the file, a TextWriter is required.
   TextWriter^ writer = gcnew StreamWriter( filename );
   xSer->Serialize( writer, myTransportation );
}

int main()
{
   SerializeObject( "XmlType.xml" );
}

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

public class Transportation
{
    public Car cars[];
} //Transportation

public class Car
{
    public int id;
} //Car

public class Test
{
    public static void main(String[] args)
    {
        Test t = new Test();
        t.SerializeObject("XmlType.xml");
    } //main

    // Return an XmlSerializer used for overriding.
    public XmlSerializer CreateOverrider()
    {
        // Create the XmlAttributes and XmlAttributeOverrides objects.
        XmlAttributes attrs = new XmlAttributes();
        XmlAttributeOverrides xOver = new XmlAttributeOverrides();

        /* Create an XmlTypeAttribute and change the name of the 
           XML type. */
        XmlTypeAttribute xType = new XmlTypeAttribute();
        xType.set_TypeName("Autos");

        // Set the XmlTypeAttribute to the XmlType property.
        attrs.set_XmlType(xType);

        /* Add the XmlAttributes to the XmlAttributeOverrides,
           specifying the member to override. */
        xOver.Add(Car.class.ToType(), attrs);

        // Create the XmlSerializer, and return it.
        XmlSerializer xSer =
            new XmlSerializer(Transportation.class.ToType(), xOver);

        return xSer;
    } //CreateOverrider

    public void SerializeObject(String fileName)
    {
        // Create an XmlSerializer instance.
        XmlSerializer xSer = CreateOverrider();

        // Create object and serialize it.
        Transportation myTransportation = new Transportation();
        Car c1 = new Car();
        c1.id = 12;
        Car c2 = new Car();
        c2.id = 44;
        myTransportation.cars = new Car[] { c1, c2 };

        // To write the file, a TextWriter is required.
        TextWriter writer = new StreamWriter(fileName);
        xSer.Serialize(writer, myTransportation);
    } //SerializeObject
} //Test

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