XmlRootAttribute 类

定义

命名空间:

System.Xml.Serialization

程序集:

netstandard.dll, System.Xml.ReaderWriter.dll

Source:

XmlRootAttribute.cs

控制属性目标的 XML 序列化，使其作为 XML 根元素。

public ref class XmlRootAttribute : Attribute

[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Enum | System.AttributeTargets.Interface | System.AttributeTargets.ReturnValue | System.AttributeTargets.Struct)]
public class XmlRootAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Enum | System.AttributeTargets.Interface | System.AttributeTargets.ReturnValue | System.AttributeTargets.Struct)>]
type XmlRootAttribute = class
    inherit Attribute

Public Class XmlRootAttribute
Inherits Attribute

继承

Object

Attribute

XmlRootAttribute

属性

AttributeUsageAttribute

示例

以下示例将应用于 XmlRootAttribute 类。 该特性指定元素名称、命名空间以及元素是否限定，以及 xsi:nil 是否将类设置为 null 时生成属性。

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

[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()
    {
    }

    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();
        t.SerializeGroup();
    }

    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);
        ser.Serialize(fs,myGroup);
        fs.Close();
        Console.WriteLine(myGroup.GroupName);
        Console.WriteLine("Done");
        Console.ReadLine();
    }
}

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

注解

属于 XmlRootAttribute 一系列属性，用于控制 XmlSerializer 如何序列化或反序列化对象。 有关类似属性的完整列表，请参阅 控制 XML 序列化的属性。

可以应用于 XmlRootAttribute 类、结构、枚举或接口。 还可以将属性应用于 XML Web 服务方法的返回值。

每个 XML 文档必须具有一个包含所有其他元素的根元素。 通过 XmlRootAttribute 设置某些属性，可以控制生成根元素的方式 XmlSerializer 。 例如，通过设置 ElementName 属性来指定生成的 XML 元素的名称。

有关使用属性的详细信息，请参阅 “属性”。

注释

可以在代码中使用单词 XmlRoot ，而不是较长 XmlRootAttribute时间。

构造函数

名称	说明
XmlRootAttribute()	初始化 XmlRootAttribute 类的新实例。
XmlRootAttribute(String)	初始化类的新实例 XmlRootAttribute 并指定 XML 根元素的名称。

属性

名称	说明
DataType	获取或设置 XML 根元素的 XSD 数据类型。
ElementName	获取或设置由类和Deserialize(Stream)方法分别生成和识别XmlSerializer的 Serialize(TextWriter, Object) XML 元素的名称。
IsNullable	获取或设置一个值，该值指示必须XmlSerializer序列化设置为属性nullxsi:nil集的成员true。
Namespace	获取或设置 XML 根元素的命名空间。
TypeId	在派生类中实现时，获取此 Attribute的唯一标识符。 (继承自 Attribute)

方法

名称	说明
Equals(Object)	返回一个值，该值指示此实例是否等于指定对象。 (继承自 Attribute)
GetHashCode()	返回此实例的哈希代码。 (继承自 Attribute)
GetType()	获取当前实例的 Type。 (继承自 Object)
IsDefaultAttribute()	在派生类中重写时，指示此实例的值是否为派生类的默认值。 (继承自 Attribute)
Match(Object)	在派生类中重写时，返回一个值，该值指示此实例是否等于指定对象。 (继承自 Attribute)
MemberwiseClone()	创建当前 Object的浅表副本。 (继承自 Object)
ToString()	返回一个表示当前对象的字符串。 (继承自 Object)

另请参阅

• XmlArrayAttribute
• XmlElementAttribute
• XmlSerializer
• XmlAttributes
• XML 序列化简介
• 如何：为 XML 流指定备用元素名称
• 使用属性控制 XML 序列化
• XML 序列化示例
• XML 架构定义工具 (Xsd.exe)