XmlRootAttribute Sınıf

Tanım

Ad Alanı:

System.Xml.Serialization

Bütünleştirilmiş Kodlar:

netstandard.dll, System.Xml.ReaderWriter.dll

Kaynak:

XmlRootAttribute.cs

Öznitelik hedefinin XML kök öğesi olarak XML serileştirmesini denetler.

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

Devralma

Object

Attribute

XmlRootAttribute

Öznitelikler

AttributeUsageAttribute

Örnekler

Aşağıdaki örnek öğesini XmlRootAttribute bir sınıfa uygular. özniteliği öğe adını, ad alanını ve öğenin nitelenmiş olup olmadığını ve sınıfı olarak ayarlanırsa nullözniteliğin xsi:nil oluşturulup oluşturulmayacağını belirtir.

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

Açıklamalar

, XmlRootAttribute bir nesnenin seri hale nasıl getirildiğini veya seri durumdan XmlSerializer çıkarıldığını denetleen bir öznitelik ailesine aittir. Benzer özniteliklerin tam listesi için bkz. XML Serileştirmesini Denetleen Öznitelikler.

öğesini XmlRootAttribute bir sınıfa, yapıya, numaralandırmaya veya arabirime uygulayabilirsiniz. Ayrıca, özniteliğini bir XML Web hizmeti yönteminin dönüş değerine de uygulayabilirsiniz.

Her XML belgesinin diğer tüm öğeleri içeren tek bir kök öğesi olmalıdır. , XmlRootAttribute belirli özellikleri ayarlayarak kök öğesinin nasıl XmlSerializer oluşturulacaklarını denetlemenize olanak tanır. Örneğin, özelliğini ayarlayarak oluşturulan XML öğesinin ElementName adını belirtin.

Öznitelikleri kullanma hakkında daha fazla bilgi için bkz . Öznitelikler.

Uyarı

uzun yerine XmlRootAttributekodunuzda sözcüğünü XmlRoot kullanabilirsiniz.

Oluşturucular

Name	Description
XmlRootAttribute()	XmlRootAttribute sınıfının yeni bir örneğini başlatır.
XmlRootAttribute(String)	Sınıfının yeni bir örneğini XmlRootAttribute başlatır ve XML kök öğesinin adını belirtir.

Özellikler

Name	Description
DataType	XML kök öğesinin XSD veri türünü alır veya ayarlar.
ElementName	Sırasıyla sınıfın Serialize(TextWriter, Object) ve yöntemleri tarafından oluşturulan ve tanınan XML öğesinin XmlSerializer adını alır veya Deserialize(Stream) ayarlar.
IsNullable	özniteliğine ayarlanmış bir üyeyi XmlSerializer seri hale getirmesi gerekip gerekmediğini belirten bir değer alır veya ayarlartrue.nullxsi:nil
Namespace	XML kök öğesi için ad alanını alır veya ayarlar.
TypeId	Türetilmiş bir sınıfta uygulandığında, bu Attributeiçin benzersiz bir tanımlayıcı alır. (Devralındığı yer: Attribute)

Yöntemler

Name	Description
Equals(Object)	Bu örneğin belirtilen bir nesneye eşit olup olmadığını gösteren bir değer döndürür. (Devralındığı yer: Attribute)
GetHashCode()	Bu örneğin karma kodunu döndürür. (Devralındığı yer: Attribute)
GetType()	Geçerli örneğin Type alır. (Devralındığı yer: Object)
IsDefaultAttribute()	Türetilmiş bir sınıfta geçersiz kılındığında, bu örneğin değerinin türetilmiş sınıf için varsayılan değer olup olmadığını gösterir. (Devralındığı yer: Attribute)
Match(Object)	Türetilmiş bir sınıfta geçersiz kılındığında, bu örneğin belirtilen bir nesneye eşit olup olmadığını gösteren bir değer döndürür. (Devralındığı yer: Attribute)
MemberwiseClone()	Geçerli Objectbasit bir kopyasını oluşturur. (Devralındığı yer: Object)
ToString()	Geçerli nesneyi temsil eden bir dize döndürür. (Devralındığı yer: Object)

Ayrıca bkz.

• XmlArrayAttribute
• XmlElementAttribute
• XmlSerializer
• XmlAttributes
• XML Serileştirmeye Giriş
• Nasıl yapılır: XML Akışı için Alternatif Öğe Adı Belirtme
• Öznitelikleri Kullanarak XML Serileştirmesini Denetleme
• XML Serileştirme Örnekleri
• XML Şema Tanımı Aracı (XSD.exe)