XmlAttributes.XmlIgnore Properti

Definisi

Ruang nama:

System.Xml.Serialization

Rakitan:

netstandard.dll, System.Xml.XmlSerializer.dll

Sumber:

XmlAttributes.cs

Mendapatkan atau menetapkan nilai yang menentukan apakah menserialisasikan bidang publik atau properti baca/tulis publik atau tidak XmlSerializer .

public:
 property bool XmlIgnore { bool get(); void set(bool value); };

public bool XmlIgnore { get; set; }

member this.XmlIgnore : bool with get, set

Public Property XmlIgnore As Boolean

Nilai Properti

Boolean

true XmlSerializer jika tidak boleh membuat serialisasi bidang atau properti; jika tidak, false.

Contoh

Contoh berikut menserialisasi kelas bernama Group, yang berisi anggota bernama Comment yang XmlIgnoreAttribute diterapkan. Contoh membuat XmlAttributes objek, dan mengatur properti ke false, sehingga mengesampingkan XmlIgnoreXmlIgnoreAttribute.

using System;
using System.IO;
using System.Xml.Serialization;

// This is the class that will be serialized.
public class Group
{
   // The GroupName value will be serialized--unless it's overridden.
   public string GroupName;

   /* This field will be ignored when serialized--
      unless it's overridden. */
   [XmlIgnoreAttribute]
   public string Comment;
}

public class Test
{
   public static void Main()
   {
      Test t = new Test();
      t.SerializeObject("IgnoreXml.xml");
   }

   // Return an XmlSerializer used for overriding.
   public XmlSerializer CreateOverrider()
   {
      // Create the XmlAttributeOverrides and XmlAttributes objects.
      XmlAttributeOverrides xOver = new XmlAttributeOverrides();
      XmlAttributes attrs = new XmlAttributes();

      /* Setting XmlIgnore to false overrides the XmlIgnoreAttribute
         applied to the Comment field. Thus it will be serialized.*/
      attrs.XmlIgnore = false;
      xOver.Add(typeof(Group), "Comment", attrs);

      /* Use the XmlIgnore to instruct the XmlSerializer to ignore
         the GroupName instead. */
      attrs = new XmlAttributes();
      attrs.XmlIgnore = true;
      xOver.Add(typeof(Group), "GroupName", attrs);

      XmlSerializer xSer = new XmlSerializer(typeof(Group), xOver);
      return xSer;
   }

   public void SerializeObject(string filename)
   {
      // Create an XmlSerializer instance.
      XmlSerializer xSer = CreateOverrider();

      // Create the object to serialize and set its properties.
      Group myGroup = new Group();
      myGroup.GroupName = ".NET";
      myGroup.Comment = "My Comment...";

      // Writing the file requires a TextWriter.
      TextWriter writer = new StreamWriter(filename);

      // Serialize the object and close the TextWriter.
      xSer.Serialize(writer, myGroup);
      writer.Close();
   }
}

Imports System.IO
Imports System.Xml.Serialization


' This is the class that will be serialized. 
Public Class Group
    ' The GroupName value will be serialized--unless it's overridden.
    Public GroupName As String
    
    ' This field will be ignored when serialized--
    '  unless it's overridden.
    <XmlIgnoreAttribute()> Public Comment As String
End Class


Public Class Test
    
    Public Shared Sub Main()
        Dim t As New Test()
        t.SerializeObject("IgnoreXml.xml")
    End Sub
    
    
    ' Return an XmlSerializer used for overriding.
    Public Function CreateOverrider() As XmlSerializer
        ' Create the XmlAttributeOverrides and XmlAttributes objects.
        Dim xOver As New XmlAttributeOverrides()
        Dim attrs As New XmlAttributes()
        
        ' Setting XmlIgnore to false overrides the XmlIgnoreAttribute
        ' applied to the Comment field. Thus it will be serialized.
        attrs.XmlIgnore = False
        xOver.Add(GetType(Group), "Comment", attrs)
        
        ' Use the XmlIgnore to instruct the XmlSerializer to ignore
        ' the GroupName instead. 
        attrs = New XmlAttributes()
        attrs.XmlIgnore = True
        xOver.Add(GetType(Group), "GroupName", attrs)
        
        Dim xSer As New XmlSerializer(GetType(Group), xOver)
        Return xSer
    End Function
    
    
    Public Sub SerializeObject(ByVal filename As String)
        ' Create an XmlSerializer instance.
        Dim xSer As XmlSerializer = CreateOverrider()
        
        ' Create the object to serialize and set its properties.
        Dim myGroup As New Group()
        myGroup.GroupName = ".NET"
        myGroup.Comment = "My Comment..."
        
        ' Writing the file requires a TextWriter.
        Dim writer As New StreamWriter(filename)
        
        ' Serialize the object and close the TextWriter.
        xSer.Serialize(writer, myGroup)
        writer.Close()
    End Sub
End Class

Keterangan

Secara default, semua bidang publik dan properti baca/tulis publik diserialisasikan oleh XmlSerializer. Artinya, nilai setiap bidang atau properti publik dipertahankan sebagai elemen XML atau atribut XML dalam instans dokumen XML.

Untuk mengambil alih serialisasi default bidang atau properti, buat XmlAttributes objek, dan atur propertinya XmlIgnore ke true. Add objek ke XmlAttributeOverrides objek dan tentukan jenis objek yang berisi bidang atau properti yang akan diabaikan, dan nama bidang atau properti yang akan diabaikan.

XmlIgnoreAttribute Jika diterapkan ke bidang atau properti, bidang atau properti diabaikan. Namun Anda dapat mengambil alih perilaku tersebut dengan membuat XmlAttributes objek, mengatur propertinya XmlIgnore ke false, menambahkannya ke objek yang XmlAttributeOverrides menentukan jenis objek yang berisi bidang atau properti, dan nama bidang atau properti.

Lihat juga

• XmlIgnoreAttribute