Windows apps
Collapse the table of content
Expand the table of content
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

XmlRootAttribute Class

Controls XML serialization of the attribute target as an XML root element.

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

public class XmlRootAttribute : Attribute

The XmlRootAttribute belongs to a family of attributes that controls how the XmlSerializer serializes or deserializes an object. For a complete list of similar attributes, see Attributes That Control XML Serialization.

You can apply the XmlRootAttribute to a class, structure, enumeration, or interface. You can also apply the attribute to the return value of an XML Web service method.

Every XML document must have a single root element that contains all the other elements. The XmlRootAttribute allows you to control how the XmlSerializer generates the root element by setting certain properties. For example, specify the name of the generated XML element by setting the ElementName property.

For more information about using attributes, see Extending Metadata Using Attributes.


You can use the word XmlRoot in your code instead of the longer XmlRootAttribute.

The following example applies the XmlRootAttribute to a class. The attribute specifies the element name, namespace, and whether the element is qualified, and whether the xsi:nil attribute is generated if the class is set to null.

using System;
using System.IO;
using System.Xml;
using System.Xml.Schema;
using System.Xml.Serialization;

[XmlRoot(Namespace = "", 
     ElementName = "MyGroupName", 
     DataType = "string", 
public class Group
    private string groupNameValue;
    // Insert code for the Group class. 
    public Group()

    public Group(string groupNameVal)
        groupNameValue = groupNameVal;

    public string GroupName
        get{return groupNameValue;}
        set{groupNameValue = value;}
public class Test
    static void Main()
        Test t = new Test();

    private void SerializeGroup()
        // Create an instance of the Group class, and an 
        // instance of the XmlSerializer to serialize it.
        Group myGroup = new Group("Redmond");
        XmlSerializer ser = new XmlSerializer(typeof(Group));
        // A FileStream is used to write the file.
        FileStream fs = new FileStream("group.xml",FileMode.Create);
#using <mscorlib.dll>
#using <System.Xml.dll>
using namespace System;
using namespace System::IO;
using namespace System::Xml;
using namespace System::Xml::Schema;
using namespace System::Xml::Serialization;

[XmlRoot(Namespace = S"", 
     ElementName = S"MyGroupName", 
     DataType = S"string", 
public __gc class Group
    String* groupNameValue;
    // Insert code for the Group class.

    Group(String* groupNameVal)
        groupNameValue = groupNameVal;
    __property String* get_GroupName()
       return groupNameValue;
    __property void set_GroupName( String* value )
       groupNameValue = value;

void SerializeGroup()
   // Create an instance of the Group class, and an
   // instance of the XmlSerializer to serialize it.
   Group* myGroup = new Group(S"Redmond");
   XmlSerializer* ser = new XmlSerializer(__typeof(Group));
   // A FileStream is used to write the file.
   FileStream* fs = new FileStream(S"group.xml",FileMode::Create);

int main()


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 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0

Community Additions

© 2017 Microsoft