XmlRootAttribute Třída

Definice

Obor názvů:

System.Xml.Serialization

Sestavení:

netstandard.dll, System.Xml.ReaderWriter.dll

Zdroj:

XmlRootAttribute.cs

Ovládá serializaci XML atributového cíle jako kořenového elementu XML.

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

Dědičnost

Object

Attribute

XmlRootAttribute

Atributy

AttributeUsageAttribute

Příklady

Následující příklad platí pro XmlRootAttribute třídu. Atribut určuje název elementu, obor názvů a zda je prvek kvalifikovaný a zda xsi:nil je atribut generován, pokud je třída nastavena na 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

Poznámky

Patří XmlRootAttribute do řady atributů, které řídí, jak XmlSerializer serializuje nebo deserializuje objekt. Úplný seznam podobných atributů naleznete v části Atributy, které řídí serializaci XML.

Můžete použít u třídy, struktury, výčtu XmlRootAttribute nebo rozhraní. Atribut můžete také použít na návratovou hodnotu metody webové služby XML.

Každý dokument XML musí mít jeden kořenový prvek, který obsahuje všechny ostatní prvky. Umožňuje XmlRootAttribute řídit, jak XmlSerializer generuje kořenový prvek nastavením určitých vlastností. Zadejte například název vygenerovaného elementu XML nastavením ElementName vlastnosti.

Další informace o používání atributů naleznete v tématu Atributy.

Poznámka:

Místo delšího XmlRootAttributekódu můžete použít slovo XmlRoot v kódu .

Konstruktory

Name	Description
XmlRootAttribute()	Inicializuje novou instanci XmlRootAttribute třídy.
XmlRootAttribute(String)	Inicializuje novou instanci XmlRootAttribute třídy a určuje název kořenového elementu XML.

Vlastnosti

Name	Description
DataType	Získá nebo nastaví datový typ XSD kořenového elementu XML.
ElementName	Získá nebo nastaví název XML elementu, který je generován a rozpoznán XmlSerializer třídou Serialize(TextWriter, Object) a Deserialize(Stream) metody, v uvedeném pořadí.
IsNullable	Získá nebo nastaví hodnotu, která určuje, zda XmlSerializer musí serializovat člen, který je nastaven na null atribut xsi:nil nastaven na true.
Namespace	Získá nebo nastaví obor názvů pro kořenový element XML.
TypeId	Při implementaci v odvozené třídě získá jedinečný identifikátor pro tento Attribute. (Zděděno od Attribute)

Metody

Name	Description
Equals(Object)	Vrátí hodnotu, která určuje, zda je tato instance rovna zadanému objektu. (Zděděno od Attribute)
GetHashCode()	Vrátí kód hash pro tuto instanci. (Zděděno od Attribute)
GetType()	Získá Type aktuální instance. (Zděděno od Object)
IsDefaultAttribute()	Při přepsání v odvozené třídě určuje, zda hodnota této instance je výchozí hodnotou pro odvozenou třídu. (Zděděno od Attribute)
Match(Object)	Při přepsání v odvozené třídě vrátí hodnotu, která určuje, zda se tato instance rovná zadanému objektu. (Zděděno od Attribute)
MemberwiseClone()	Vytvoří mělkou kopii aktuálního Object. (Zděděno od Object)
ToString()	Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object)

Viz také

• XmlArrayAttribute
• XmlElementAttribute
• XmlSerializer
• XmlAttributes
• Představujeme serializaci XML
• Postupy: Určení alternativního názvu elementu pro datový proud XML
• Řízení serializace XML pomocí atributů
• Příklady serializace XML
• Nástroj XML Schema Definition (Xsd.exe)