XmlRootAttribute Klass

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

Arv

Object

Attribute

XmlRootAttribute

Attribut

AttributeUsageAttribute

Exempel

Följande exempel gäller XmlRootAttribute för en klass. Attributet anger elementnamnet, namnområdet och om elementet är kvalificerat och om xsi:nil attributet genereras om klassen är inställd på 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

Kommentarer

XmlRootAttribute Tillhör en familj av attribut som styr hur XmlSerializer serialiserar eller deserialiserar ett objekt. En fullständig lista över liknande attribut finns i Attribut som styr XML-serialisering.

Du kan använda för XmlRootAttribute en klass, struktur, uppräkning eller gränssnitt. Du kan också använda attributet för returvärdet för en XML-webbtjänstmetod.

Varje XML-dokument måste ha ett enda rotelement som innehåller alla andra element. Gör XmlRootAttribute att du kan styra hur XmlSerializer genererar rotelementet genom att ange vissa egenskaper. Ange till exempel namnet på det genererade XML-elementet genom att ange ElementName egenskapen.

Mer information om hur du använder attribut finns i Attribut.

Se även

• XmlArrayAttribute
• XmlElementAttribute
• XmlSerializer
• XmlAttributes
• Introduktion till XML-serialisering
• Anvisningar: Ange ett alternativt elementnamn för en XML-dataström
• Kontrollera XML-serialisering med hjälp av attribut
• Exempel på XML-serialisering
• XML-schemadefinitionsverktyg (Xsd.exe)