XmlRootAttribute Osztály

Definíció

Névtér:

System.Xml.Serialization

Szerelvények:

netstandard.dll, System.Xml.ReaderWriter.dll

Forrás:

XmlRootAttribute.cs

Az attribútum-cél XML-szerializálását szabályozza XML-gyökérelemként.

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

Öröklődés

Object

Attribute

XmlRootAttribute

Attribútumok

AttributeUsageAttribute

Példák

Az alábbi példa egy XmlRootAttribute osztályra vonatkozik. Az attribútum megadja az elem nevét, a névteret, valamint azt, hogy az elem minősített-e, és hogy az xsi:nil attribútum létrejön-e, ha az osztály be van állítva 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

Megjegyzések

Az XmlRootAttribute attribútumcsalád az objektum szerializálásának vagy deszerializálásának módját szabályozza XmlSerializer . A hasonló attribútumok teljes listáját az XML-szerializálást vezérlő attribútumok című témakörben találja.

Alkalmazhatja az XmlRootAttribute osztályra, struktúrára, enumerálásra vagy interfészre. Az attribútumot xml webszolgáltatás-metódus visszatérési értékére is alkalmazhatja.

Minden XML-dokumentumnak egyetlen gyökérelemrel kell rendelkeznie, amely az összes többi elemet tartalmazza. Ez XmlRootAttribute lehetővé teszi a gyökérelem létrehozásának szabályozását XmlSerializer bizonyos tulajdonságok beállításával. Adja meg például a létrehozott XML-elem nevét a ElementName tulajdonság beállításával.

Az attribútumok használatáról további információt az Attribútumok című témakörben talál.

Note

A hosszabb helyett használhatja a szót XmlRoot a XmlRootAttributekódban.

Konstruktorok

Name	Description
XmlRootAttribute()	Inicializálja a XmlRootAttribute osztály új példányát.
XmlRootAttribute(String)	Inicializálja az XmlRootAttribute osztály új példányát, és megadja az XML-gyökérelem nevét.

Tulajdonságok

Name	Description
DataType	Lekéri vagy beállítja az XML-gyökérelem XSD-adattípusát.
ElementName	Lekéri vagy beállítja az osztály XmlSerializerSerialize(TextWriter, Object) és a metódusok által Deserialize(Stream) létrehozott és felismert XML-elem nevét.
IsNullable	Lekéri vagy beállít egy értéket, amely jelzi, hogy az XmlSerializer adott tagnak szerializálnia null kell-e egy olyan tagotxsi:nil, amely a true következő attribútumra van állítva.
Namespace	Lekéri vagy beállítja az XML-gyökérelem névterét.
TypeId	Ha származtatott osztályban implementálják, ehhez egy egyedi azonosítót Attributekap. (Öröklődés forrása Attribute)

Metódusok

Name	Description
Equals(Object)	Olyan értéket ad vissza, amely jelzi, hogy ez a példány egyenlő-e egy adott objektummal. (Öröklődés forrása Attribute)
GetHashCode()	A példány kivonatkódját adja vissza. (Öröklődés forrása Attribute)
GetType()	Lekéri az Type aktuális példányt. (Öröklődés forrása Object)
IsDefaultAttribute()	Ha egy származtatott osztályban felül van bírálva, azt jelzi, hogy a példány értéke-e a származtatott osztály alapértelmezett értéke. (Öröklődés forrása Attribute)
Match(Object)	Származtatott osztály felülírásakor egy olyan értéket ad vissza, amely jelzi, hogy ez a példány egy adott objektummal egyenlő-e. (Öröklődés forrása Attribute)
MemberwiseClone()	Az aktuális Objectpéldány sekély másolatát hozza létre. (Öröklődés forrása Object)
ToString()	Az aktuális objektumot jelképező sztringet ad vissza. (Öröklődés forrása Object)

Lásd még

• XmlArrayAttribute
• XmlElementAttribute
• XmlSerializer
• XmlAttributes
• Az XML-szerializálás bemutatása
• Útmutató: Alternatív elemnév megadása XML-adatfolyamhoz
• XML-szerializálás szabályozása attribútumokkal
• Példák XML-szerializálásra
• XML-sémadefiníciós eszköz (Xsd.exe)