XmlIgnoreAttribute Kelas

Definisi

Ruang nama:

System.Xml.Serialization

Rakitan:

netstandard.dll, System.Xml.ReaderWriter.dll

Sumber:

XmlIgnoreAttribute.cs

Menginstruksikan metode Serialize(TextWriter, Object)XmlSerializer untuk tidak membuat serial bidang publik atau nilai properti baca/tulis publik.

public ref class XmlIgnoreAttribute : Attribute

[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.Property | System.AttributeTargets.ReturnValue)]
public class XmlIgnoreAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.Property | System.AttributeTargets.ReturnValue)>]
type XmlIgnoreAttribute = class
    inherit Attribute

Public Class XmlIgnoreAttribute
Inherits Attribute

Warisan

Object

Attribute

XmlIgnoreAttribute

Atribut

AttributeUsageAttribute

Contoh

Contoh berikut menunjukkan kelas bernama Group, yang berisi bidang bernama Comment. Contoh menetapkan ke bidang , sehingga menginstruksikan XmlIgnoreAttributeXmlSerializer untuk mengabaikan bidang saat menserialisasikan atau mendeserialisasi instans kelas.

public class Group
{
   // The XmlSerializer ignores this field.
   [XmlIgnore]
   public string Comment;

   // The XmlSerializer serializes this field.
   public string GroupName;
}

Public Class Group
    ' the XmlSerializer ignores this field.
    <XmlIgnore()> Public Comment As String
    
    ' The XmlSerializer serializes this field.
    Public GroupName As String
End Class

Keterangan

XmlIgnoreAttribute milik keluarga atribut yang mengontrol bagaimana XmlSerializer serialisasi atau deserialisasi objek. Jika Anda menerapkan ke XmlIgnoreAttribute anggota kelas mana pun, mengabaikan XmlSerializer anggota saat membuat serialisasi atau mendeserialisasi instans kelas. Untuk daftar lengkap atribut serupa, lihat Atribut yang Mengontrol Serialisasi XML.

Anda dapat mengambil alih perilaku yang disebabkan oleh XmlIgnoreAttribute pembuatan XmlAttributes objek, dan mengatur propertinya XmlIgnore ke false. Anda harus Add objek XmlAttributes ke instans XmlAttributeOverrides kelas. Terakhir, Anda harus menggunakan XmlAttributeOverrides objek untuk membuat instans XmlSerializer kelas sebelum Anda memanggil Serialize metode atau Deserialize .

Alat Definisi Skema XML (Xsd.exe) kadang-kadang menghasilkan XmlIgnoreAttribute saat membuat kelas dari file skema (.xsd). Perilaku ini terjadi karena jenis nilai tidak dapat diatur ke null, tetapi semua jenis data XML bisa. Oleh karena itu, alat ini membuat dua bidang ketika menemukan jenis XML yang memetakan ke jenis nilai: satu untuk menahan nilai dan bidang khusus lainnya yang mengambil bentuk fieldnameSpecified, di mana fieldname digantikan dengan nama bidang atau properti. Perhatikan, bagaimanapun, bahwa bidang khusus ini dihasilkan hanya ketika skema menentukan bahwa elemen tidak memiliki kemunculan minimum (minOccurs = "0") dan bahwa elemen tidak memiliki nilai default. Set XmlSerializer dan memeriksa bidang khusus ini untuk menentukan apakah nilai telah ditetapkan untuk bidang atau properti. Karena bidang khusus tidak boleh diserialisasikan, alat menerapkannya XmlIgnoreAttribute .

Untuk informasi selengkapnya tentang menggunakan atribut, lihat Atribut.

Nota

Anda dapat menggunakan kata XmlIgnore dalam kode Anda alih-alih lebih lama XmlIgnoreAttribute.

Konstruktor

Nama	Deskripsi
XmlIgnoreAttribute()	Menginisialisasi instans baru dari kelas XmlIgnoreAttribute.

Properti

Nama	Deskripsi
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

• XmlAttributeOverrides
• XmlAttributes
• XmlIgnore
• XmlSerializer
• 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)