XmlRootAttribute Classe

Definizione

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

Ereditarietà

Object

Attribute

XmlRootAttribute

Attributi

AttributeUsageAttribute

Esempio

Nell'esempio seguente viene applicato a XmlRootAttribute una classe . L'attributo specifica il nome dell'elemento, lo spazio dei nomi e se l'elemento è qualificato e se l'attributo xsi:nil viene generato se la classe è impostata su 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

Commenti

Appartiene XmlRootAttribute a una famiglia di attributi che controlla la XmlSerializer modalità di serializzazione o deserializzazione di un oggetto. Per un elenco completo di attributi simili, vedere Attributi che controllano la serializzazione XML.

È possibile applicare a XmlRootAttribute una classe, una struttura, un'enumerazione o un'interfaccia. È anche possibile applicare l'attributo al valore restituito di un metodo di servizio Web XML.

Ogni documento XML deve avere un singolo elemento radice che contiene tutti gli altri elementi. XmlRootAttribute consente di controllare la modalità di generazione dell'elemento XmlSerializer radice impostando determinate proprietà. Ad esempio, specificare il nome dell'elemento XML generato impostando la ElementName proprietà .

Per altre informazioni sull'uso degli attributi, vedere Attributi.

Vedi anche

• XmlArrayAttribute
• XmlElementAttribute
• XmlSerializer
• XmlAttributes
• Introduzione alla serializzazione XML
• Procedura: Specificare un nome di elemento alternativo per un flusso XML
• Controllo della serializzazione XML tramite attributi
• Esempi di serializzazione XML
• Xml Schema Definition Tool (Xsd.exe)