XmlRootAttribute Klasse

Definition

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

Vererbung

Object

Attribute

XmlRootAttribute

Attribute

AttributeUsageAttribute

Beispiele

Im folgenden Beispiel wird die XmlRootAttribute Klasse angewendet. Das Attribut gibt den Elementnamen, namespace und an, ob das Element qualifiziert ist, und ob das xsi:nil Attribut generiert wird, wenn die Klasse auf ".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

Hinweise

Dies XmlRootAttribute gehört zu einer Familie von Attributen, die steuert, wie das XmlSerializer Serialisieren oder Deserialisieren eines Objekts. Eine vollständige Liste ähnlicher Attribute finden Sie unter Attributes That Control XML Serialization.

Sie können die XmlRootAttribute Klasse, Struktur, Aufzählung oder Schnittstelle anwenden. Sie können das Attribut auch auf den Rückgabewert einer XML-Webdienstmethode anwenden.

Jedes XML-Dokument muss über ein einzelnes Stammelement verfügen, das alle anderen Elemente enthält. Auf XmlRootAttribute diese Weise können Sie steuern, wie das XmlSerializer Stammelement generiert wird, indem Sie bestimmte Eigenschaften festlegen. Geben Sie beispielsweise den Namen des generierten XML-Elements an, indem Sie die ElementName Eigenschaft festlegen.

Weitere Informationen zur Verwendung von Attributen finden Sie unter "Attribute".

Weitere Informationen

• XmlArrayAttribute
• XmlElementAttribute
• XmlSerializer
• XmlAttributes
• Einführung in die XML-Serialisierung
• Vorgehensweise: Angeben eines alternativen Elementnamens für einen XML-Stream
• Steuern der XML-Serialisierung mithilfe von Attributen
• Beispiele für die XML-Serialisierung
• XML Schema Definition-Tool (Xsd.exe)