XmlRootAttribute Class
Assembly: System.Xml (in system.xml.dll)
'Declaration <AttributeUsageAttribute(AttributeTargets.Class Or AttributeTargets.Struct Or AttributeTargets.Enum Or AttributeTargets.Interface Or AttributeTargets.ReturnValue)> _ Public Class XmlRootAttribute Inherits Attribute 'Usage Dim instance As XmlRootAttribute
/** @attribute AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Struct|AttributeTargets.Enum|AttributeTargets.Interface|AttributeTargets.ReturnValue) */ public class XmlRootAttribute extends Attribute
AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Struct|AttributeTargets.Enum|AttributeTargets.Interface|AttributeTargets.ReturnValue) public class XmlRootAttribute extends 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.
Note |
|---|
| 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 a null reference (Nothing in Visual Basic).
Imports System Imports System.IO Imports System.Xml Imports System.Xml.Schema Imports System.Xml.Serialization <XmlRoot(Namespace:="www.contoso.com", _ ElementName:="MyGroupName", _ DataType:="string", _ IsNullable:=True)> _ Public Class Group Private groupNameValue As String ' Insert code for the Group class. Public Sub New() End Sub Public Sub New(ByVal groupNameVal As String) groupNameValue = groupNameVal End Sub Property GroupName() As String Get Return groupNameValue End Get Set(ByVal Value As String) groupNameValue = Value End Set End Property End Class Public Class Test Shared Sub Main() Dim t As Test = New Test() t.SerializeGroup() End Sub Private Sub SerializeGroup() ' Create an instance of the Group class, and an ' instance of the XmlSerializer to serialize it. Dim myGroup As Group = New Group("Redmond") Dim ser As XmlSerializer = New XmlSerializer(GetType(Group)) ' A FileStream is used to write the file. Dim fs As FileStream = New FileStream("group.xml", FileMode.Create) ser.Serialize(fs, myGroup) fs.Close() Console.WriteLine(myGroup.GroupName) Console.WriteLine("Done... Press any key to exit.") Console.ReadLine() End Sub End Class
import System.*;
import System.IO.*;
import System.Xml.*;
import System.Xml.Schema.*;
import System.Xml.Serialization.*;
/** @attribute XmlRoot(Namespace = "www.contoso.com", ElementName = "MyGroupName",
DataType = "string", IsNullable = true)
*/
public class Group
{
private String groupNameValue;
// Insert code for the Group class.
public Group()
{
} //Group
public Group(String groupNameVal)
{
groupNameValue = groupNameVal;
} //Group
/** @property
*/
public String get_GroupName()
{
return groupNameValue;
} //get_GroupName
/** @property
*/
public void set_GroupName(String value)
{
groupNameValue = value;
} //set_GroupName
} //Group
public class Test
{
public static void main(String[] args)
{
Test t = new Test();
t.SerializeGroup();
} //main
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(Group.class.ToType());
// A FileStream is used to write the file.
FileStream fs = new FileStream("group.xml", FileMode.Create);
ser.Serialize(fs, myGroup);
fs.Close();
Console.WriteLine(myGroup.get_GroupName());
Console.WriteLine("Done");
Console.ReadLine();
} //SerializeGroup
} //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.
Reference
XmlRootAttribute MembersSystem.Xml.Serialization Namespace
XmlArrayAttribute Class
XmlElementAttribute Class
XmlSerializer
XmlAttributes Class
Other Resources
Introducing XML SerializationHow to: Specify an Alternate Element Name for an XML Stream
Controlling XML Serialization Using Attributes
Examples of XML Serialization
XML Schema Definition Tool (Xsd.exe)
Note