Export (0) Print
Expand All

XmlAttributes.XmlText Property

Gets or sets an object that instructs the XmlSerializer to serialize a public field or public read/write property as XML text.

Namespace:  System.Xml.Serialization
Assembly:  System.Xml (in System.Xml.dll)

'Declaration
Public Property XmlText As XmlTextAttribute
'Usage
Dim instance As XmlAttributes 
Dim value As XmlTextAttribute 

value = instance.XmlText

instance.XmlText = value

Property Value

Type: System.Xml.Serialization.XmlTextAttribute
An XmlTextAttribute that overrides the default serialization of a public property or field.

By default, a public field or public read/write property is serialized as an XML element by the XmlSerializer. However, it can force the field or property to be serialized as XML text by applying an XmlTextAttribute to the field or property.

NoteNote:

The XmlTextAttribute cannot be applied to a field or property that returns an array.

To override the default serialization of a field or property (that does not return an array), create an XmlTextAttribute and assign it to the XmlText property of an XmlAttributes object. Add the XmlAttributes object to an XmlAttributeOverrides object and specify the type of the object that contains the overridden field or property, and the name of the overridden field or property.

The following example serializes the class named Group, which contains a field named Comment. To override the default way the XmlSerializer serializes the field, the example creates an XmlAttributeOverrides and an XmlAttributes object. The example then creates an XmlTextAttribute object, which it assigns to the XmlText property, and adds the XmlAttributes object (with the name of the field to be serialized as XML text) to the XmlAttributeOverrides object. Lastly the example creates an XmlSerializer using the XmlAttributeOverrides object.

Imports System
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
#using <mscorlib.dll>
#using <System.Xml.dll>
using namespace System;
using namespace System::IO;
using namespace System::Xml;
using namespace System::Xml::Serialization;

// This is the class that will be serialized.
public __gc class Group
{
public:
   String* GroupName;

   // This field will be serialized as XML text. 
   String* Comment;
};

// Return an XmlSerializer to be used for overriding. 
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), S"Comment", xAttrs);

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

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 = S".NET";
   myGroup->Comment = S"Great Stuff!";      
   // Serialize the class, and close the TextWriter.
   mySerializer->Serialize(writer, myGroup);
   writer->Close();
}

void DeserializeObject(String* filename)
{
   XmlSerializer* mySerializer = CreateOverrider();
   FileStream* fs = new FileStream(filename, FileMode::Open);
   Group* myGroup = dynamic_cast<Group*>(mySerializer->Deserialize(fs));
   Console::WriteLine(myGroup->GroupName);
   Console::WriteLine(myGroup->Comment);
}

int main()
{
   SerializeObject(S"OverrideText.xml");
   DeserializeObject(S"OverrideText.xml");
}

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0

XNA Framework

Supported in: 3.0, 2.0, 1.0

Community Additions

ADD
Show:
© 2015 Microsoft