XmlAttributes.XmlIgnore Özellik

Tanım

Ad Alanı:

System.Xml.Serialization

Bütünleştirilmiş Kodlar:

netstandard.dll, System.Xml.XmlSerializer.dll

Kaynak:

XmlAttributes.cs

Bir ortak alanı veya genel okuma/yazma özelliğini serileştirip serileştirmeyeceğini XmlSerializer belirten bir değer alır veya ayarlar.

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

Özellik Değeri

Boolean

true XmlSerializer alanı veya özelliği seri hale getirmemelidir; değilse, false.

Örnekler

Aşağıdaki örnek, öğesinin uygulandığı adlı Groupbir üyeyi içeren adlı CommentXmlIgnoreAttribute sınıfı serileştirir. Örnek bir XmlAttributes nesne oluşturur ve özelliğini olarak falseayarlarXmlIgnore, böylece geçersiz kılınabilirXmlIgnoreAttribute.

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

Açıklamalar

Varsayılan olarak, tüm genel alanlar ve genel okuma/yazma özellikleri tarafından XmlSerializerserileştirilir. Diğer bir ifadeyle, her bir ortak alanın veya özelliğin değeri, XML belgesi örneğinde XML öğesi veya XML özniteliği olarak kalıcı hale getirilir.

Bir alan veya özelliğin varsayılan serileştirmesini geçersiz kılmak için bir XmlAttributes nesne oluşturun ve özelliğini olarak trueayarlayınXmlIgnore. Add nesnesine gidin XmlAttributeOverrides ve yoksayılacak alanı veya özelliği içeren nesnenin türünü ve yoksayılacak alan veya özelliğin adını belirtin.

bir XmlIgnoreAttribute alan veya özelliğe uygulanırsa, alan veya özellik yoksayılır. Ancak, bir XmlAttributes nesne oluşturarak, özelliğini olarak falseayarlayarakXmlIgnore, alanı veya özelliği içeren nesnenin türünü ve alan veya özelliğin adını belirten bir XmlAttributeOverrides nesneye ekleyerek bu davranışı geçersiz kılabilirsiniz.

Ayrıca bkz.

• XmlIgnoreAttribute