XmlRootAttribute Classe

Definição

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

Herança

Object

Attribute

XmlRootAttribute

Atributos

AttributeUsageAttribute

Exemplos

O exemplo a seguir aplica-se a XmlRootAttribute uma classe. O atributo especifica o nome do elemento, o namespace e se o elemento é qualificado e se o xsi:nil atributo é gerado se a classe está definida como 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

Comentários

Pertence XmlRootAttribute a uma família de atributos que controla como o XmlSerializer serializa ou desserializa um objeto. Para obter uma lista completa de atributos semelhantes, consulte Atributos que controlam a serialização XML.

Você pode aplicar a XmlRootAttribute uma classe, estrutura, enumeração ou interface. Você também pode aplicar o atributo ao valor retornado de um método de serviço Web XML.

Cada documento XML deve ter um único elemento raiz que contenha todos os outros elementos. O XmlRootAttribute permite controlar como o XmlSerializer elemento raiz gera definindo determinadas propriedades. Por exemplo, especifique o nome do elemento XML gerado definindo a ElementName propriedade.

Para obter mais informações sobre como usar atributos, consulte Atributos.

Confira também

• XmlArrayAttribute
• XmlElementAttribute
• XmlSerializer
• XmlAttributes
• Introdução à serialização XML
• Como especificar um nome de elemento alternativo para um fluxo XML
• Controlando a serialização XML usando atributos
• Exemplos de serialização XML
• Ferramenta de Definição de Esquema XML (Xsd.exe)