XmlAttributes.XmlIgnore Vlastnost

Definice

Obor názvů:

System.Xml.Serialization

Sestavení:

netstandard.dll, System.Xml.XmlSerializer.dll

Zdroj:

XmlAttributes.cs

Získá nebo nastaví hodnotu, která určuje, zda XmlSerializer serializuje veřejné pole nebo veřejné čtení/zápis vlastnost.

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

Hodnota vlastnosti

Boolean

true XmlSerializer pokud nesmí serializovat pole nebo vlastnost; jinak, false.

Příklady

Následující příklad serializuje třídu s názvem Group, která obsahuje člen pojmenovaný Comment , na který XmlIgnoreAttribute je použita. Příklad vytvoří XmlAttributes objekt a nastaví XmlIgnore vlastnost na false, čímž přepsání XmlIgnoreAttribute.

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

Poznámky

Ve výchozím nastavení jsou všechna veřejná pole a veřejné vlastnosti pro čtení/zápis serializovány objektem XmlSerializer. To znamená, že hodnota každého veřejného pole nebo vlastnosti je zachována jako xml element nebo xml atribut v instanci dokumentu XML.

Chcete-li přepsat výchozí serializace pole nebo vlastnosti, vytvořte XmlAttributes objekt a nastavte jeho XmlIgnore vlastnost na true. Add objektu objektu XmlAttributeOverrides a zadejte typ objektu, který obsahuje pole nebo vlastnost, které chcete ignorovat, a název pole nebo vlastnosti, které chcete ignorovat.

XmlIgnoreAttribute Pokud je použit na pole nebo vlastnost, pole nebo vlastnost se ignoruje. Toto chování však můžete přepsat vytvořením objektuXmlAttributes, nastavením jeho XmlIgnore vlastnosti do falseXmlAttributeOverrides objektu, který určuje typ objektu, který obsahuje pole nebo vlastnost, a název pole nebo vlastnosti.

Viz také

• XmlIgnoreAttribute