XmlRootAttribute Kelas

Definisi

Ruang nama:

System.Xml.Serialization

Rakitan:

netstandard.dll, System.Xml.ReaderWriter.dll

Sumber:

XmlRootAttribute.cs

Mengontrol serialisasi XML dari target atribut sebagai elemen akar 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

Warisan

Object

Attribute

XmlRootAttribute

Atribut

AttributeUsageAttribute

Contoh

Contoh berikut menerapkan ke XmlRootAttribute kelas. Atribut menentukan nama elemen, namespace, dan apakah elemen memenuhi syarat, dan apakah xsi:nil atribut dihasilkan jika kelas diatur ke 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

Keterangan

XmlRootAttribute milik keluarga atribut yang mengontrol bagaimana XmlSerializer serialisasi atau deserialisasi objek. Untuk daftar lengkap atribut serupa, lihat Atribut yang Mengontrol Serialisasi XML.

Anda dapat menerapkan ke XmlRootAttribute kelas, struktur, enumerasi, atau antarmuka. Anda juga dapat menerapkan atribut ke nilai pengembalian metode layanan Web XML.

Setiap dokumen XML harus memiliki satu elemen akar yang berisi semua elemen lainnya. memungkinkan XmlRootAttribute Anda mengontrol bagaimana XmlSerializer menghasilkan elemen akar dengan mengatur properti tertentu. Misalnya, tentukan nama elemen XML yang dihasilkan dengan mengatur ElementName properti .

Untuk informasi selengkapnya tentang menggunakan atribut, lihat Atribut.

Nota

Anda dapat menggunakan kata XmlRoot dalam kode Anda alih-alih lebih lama XmlRootAttribute.

Konstruktor

Nama	Deskripsi
XmlRootAttribute()	Menginisialisasi instans baru dari kelas XmlRootAttribute.
XmlRootAttribute(String)	Menginisialisasi instans XmlRootAttribute baru kelas dan menentukan nama elemen akar XML.

Properti

Nama	Deskripsi
DataType	Mendapatkan atau mengatur jenis data XSD dari elemen akar XML.
ElementName	Mendapatkan atau mengatur nama elemen XML yang dihasilkan dan dikenali oleh XmlSerializer kelas Serialize(TextWriter, Object) dan Deserialize(Stream) metode.
IsNullable	Mendapatkan atau menetapkan nilai yang menunjukkan apakah XmlSerializer harus membuat serial anggota yang diatur ke null dalam atribut yang xsi:nil diatur ke true.
Namespace	Mendapatkan atau mengatur namespace layanan untuk elemen akar XML.
TypeId	Ketika diimplementasikan dalam kelas turunan, mendapatkan pengidentifikasi unik untuk Attributeini. (Diperoleh dari Attribute)

Metode

Nama	Deskripsi
Equals(Object)	Mengembalikan nilai yang menunjukkan apakah instans ini sama dengan objek tertentu. (Diperoleh dari Attribute)
GetHashCode()	Mengembalikan kode hash untuk instans ini. (Diperoleh dari Attribute)
GetType()	Mendapatkan Type instans saat ini. (Diperoleh dari Object)
IsDefaultAttribute()	Ketika ditimpa dalam kelas turunan, menunjukkan apakah nilai instans ini adalah nilai default untuk kelas turunan. (Diperoleh dari Attribute)
Match(Object)	Saat ditimpa dalam kelas turunan, mengembalikan nilai yang menunjukkan apakah instans ini sama dengan objek tertentu. (Diperoleh dari Attribute)
MemberwiseClone()	Membuat salinan dangkal dari Objectsaat ini. (Diperoleh dari Object)
ToString()	Mengembalikan string yang mewakili objek saat ini. (Diperoleh dari Object)

Lihat juga

• XmlArrayAttribute
• XmlElementAttribute
• XmlSerializer
• XmlAttributes
• Memperkenalkan Serialisasi XML
• Cara: Menentukan Nama Elemen Alternatif untuk Aliran XML
• Mengontrol Serialisasi XML Menggunakan Atribut
• Contoh Serialisasi XML
• Alat Definisi Skema XML (Xsd.exe)