XmlAttributes.XmlText Vlastnost

Definice

Obor názvů:

System.Xml.Serialization

Sestavení:

netstandard.dll, System.Xml.XmlSerializer.dll

Zdroj:

XmlAttributes.cs

Získá nebo nastaví objekt, který dává pokyn XmlSerializer k serializaci veřejného pole nebo veřejné read/write vlastnost jako xml text.

public:
 property System::Xml::Serialization::XmlTextAttribute ^ XmlText { System::Xml::Serialization::XmlTextAttribute ^ get(); void set(System::Xml::Serialization::XmlTextAttribute ^ value); };

public System.Xml.Serialization.XmlTextAttribute? XmlText { get; set; }

member this.XmlText : System.Xml.Serialization.XmlTextAttribute with get, set

Public Property XmlText As XmlTextAttribute

Hodnota vlastnosti

XmlTextAttribute

Přepíše XmlTextAttribute výchozí serializaci veřejné vlastnosti nebo pole.

Příklady

Následující příklad serializuje třídu s názvem Group, která obsahuje pole s názvem Comment. Chcete-li přepsat výchozí způsob XmlSerializer serializace pole, příklad vytvoří XmlAttributeOverrides a XmlAttributes objekt. Příklad pak vytvoří XmlTextAttribute objekt, který přiřadí k XmlText vlastnosti, a přidá XmlAttributes objekt (s názvem pole, které má být serializováno jako text XML) objektu XmlAttributeOverrides . Nakonec příklad vytvoří XmlSerializer pomocí objektu XmlAttributeOverrides .

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

// This is the class that will be serialized.
public class Group
{
   public string GroupName;

   // This field will be serialized as XML text.
   public string Comment;
}

public class Run
{
   public static void Main()
   {
      Run test = new Run();
      test.SerializeObject("OverrideText.xml");
      test.DeserializeObject("OverrideText.xml");
   }

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

      /* Create an XmlTextAttribute and assign it to the XmlText
      property. This instructs the XmlSerializer to treat the
      Comment field as XML text. */
      XmlTextAttribute xText = new XmlTextAttribute();
      xAttrs.XmlText = xText;
      xOver.Add(typeof(Group), "Comment", xAttrs);

      // Create the XmlSerializer, and return it.
      return new XmlSerializer(typeof(Group), xOver);
   }

   public void SerializeObject(string filename)
   {
      // Create an instance of the XmlSerializer class.
      XmlSerializer mySerializer =  CreateOverrider();
      // Writing the file requires a TextWriter.
      TextWriter writer = new StreamWriter(filename);

      // Create an instance of the class that will be serialized.
      Group myGroup = new Group();

      // Set the object properties.
      myGroup.GroupName = ".NET";
      myGroup.Comment = "Great Stuff!";
      // Serialize the class, and close the TextWriter.
      mySerializer.Serialize(writer, myGroup);
      writer.Close();
   }

   public void DeserializeObject(string filename)
   {
      XmlSerializer mySerializer = CreateOverrider();
      FileStream fs = new FileStream(filename, FileMode.Open);
      Group myGroup = (Group)
      mySerializer.Deserialize(fs);
      Console.WriteLine(myGroup.GroupName);
      Console.WriteLine(myGroup.Comment);
   }
}

Imports System.IO
Imports System.Xml
Imports System.Xml.Serialization


' This is the class that will be serialized.
Public Class Group
    Public GroupName As String
    
    ' This field will be serialized as XML text. 
    Public Comment As String
End Class


Public Class Run
    
    Public Shared Sub Main()
        Dim test As New Run()
        test.SerializeObject("OverrideText.xml")
        test.DeserializeObject("OverrideText.xml")
    End Sub

        
    ' Return an XmlSerializer to be used for overriding. 
    Public Function CreateOverrider() As XmlSerializer
        ' Create the XmlAttributeOverrides and XmlAttributes objects.
        Dim xOver As New XmlAttributeOverrides()
        Dim xAttrs As New XmlAttributes()
        
        ' Create an XmlTextAttribute and assign it to the XmlText
        ' property. This instructs the XmlSerializer to treat the
        ' Comment field as XML text. 
        Dim xText As New XmlTextAttribute()
        xAttrs.XmlText = xText
        xOver.Add(GetType(Group), "Comment", xAttrs)
        
        ' Create the XmlSerializer, and return it.
        Return New XmlSerializer(GetType(Group), xOver)
    End Function
    
    
    
    Public Sub SerializeObject(ByVal filename As String)
        ' Create an instance of the XmlSerializer class.
        Dim mySerializer As XmlSerializer = CreateOverrider()
        ' Writing the file requires a TextWriter.
        Dim writer As New StreamWriter(filename)
        
        ' Create an instance of the class that will be serialized.
        Dim myGroup As New Group()
        
        ' Set the object properties.
        myGroup.GroupName = ".NET"
        myGroup.Comment = "Great Stuff!"
        ' Serialize the class, and close the TextWriter.
        mySerializer.Serialize(writer, myGroup)
        writer.Close()
    End Sub
    
    
    Public Sub DeserializeObject(ByVal filename As String)
        Dim mySerializer As XmlSerializer = CreateOverrider()
        Dim fs As New FileStream(filename, FileMode.Open)
        Dim myGroup As Group = CType(mySerializer.Deserialize(fs), Group)
        Console.WriteLine(myGroup.GroupName)
        Console.WriteLine(myGroup.Comment)
    End Sub
End Class

Poznámky

Ve výchozím nastavení je veřejné pole nebo veřejné read/write vlastnost serializována jako XML elementu XmlSerializer. Může však vynutit serializaci pole nebo vlastnosti jako text XML použitím XmlTextAttribute pole nebo vlastnosti.

Poznámka:

Nelze použít XmlTextAttribute u pole nebo vlastnosti, která vrací pole.

Chcete-li přepsat výchozí serializaci pole nebo vlastnosti (která nevrací pole), vytvořte XmlTextAttribute a přiřaďte ji k XmlText vlastnosti objektu XmlAttributes . XmlAttributes Přidejte objekt do XmlAttributeOverrides objektu a zadejte typ objektu, který obsahuje přepsáné pole nebo vlastnost, a název přepsáného pole nebo vlastnosti.