XmlTextAttribute Class
Indicates to the XmlSerializer that the member must be treated as XML text when the class that contains it is serialized or deserialized.
Assembly: System.Xml (in System.Xml.dll)
| Name | Description | |
|---|---|---|
![]() | XmlTextAttribute() | Initializes a new instance of the XmlTextAttribute class. |
![]() | XmlTextAttribute(Type^) | Initializes a new instance of the XmlTextAttribute class. |
| Name | Description | |
|---|---|---|
![]() | Equals(Object^) | This API supports the product infrastructure and is not intended to be used directly from your code. Returns a value that indicates whether this instance is equal to a specified object.(Inherited from Attribute.) |
![]() | Finalize() | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.) |
![]() | GetHashCode() | Returns the hash code for this instance.(Inherited from Attribute.) |
![]() | GetType() | |
![]() | IsDefaultAttribute() | When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.(Inherited from Attribute.) |
![]() | Match(Object^) | When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.(Inherited from Attribute.) |
![]() | MemberwiseClone() | |
![]() | ToString() | Returns a string that represents the current object.(Inherited from Object.) |
| Name | Description | |
|---|---|---|
![]() ![]() | _Attribute::GetIDsOfNames(Guid%, IntPtr, UInt32, UInt32, IntPtr) | Maps a set of names to a corresponding set of dispatch identifiers.(Inherited from Attribute.) |
![]() ![]() | _Attribute::GetTypeInfo(UInt32, UInt32, IntPtr) | Retrieves the type information for an object, which can be used to get the type information for an interface.(Inherited from Attribute.) |
![]() ![]() | _Attribute::GetTypeInfoCount(UInt32%) | Retrieves the number of type information interfaces that an object provides (either 0 or 1).(Inherited from Attribute.) |
![]() ![]() | _Attribute::Invoke(UInt32, Guid%, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) | Provides access to properties and methods exposed by an object.(Inherited from Attribute.) |
The XmlTextAttribute belongs to a family of attributes that controls how the XmlSerializer serializes and deserializes an object (through its Serialize and Deserialize methods). For a complete list of similar attributes, see Attributes That Control XML Serialization.
Only one instance of the XmlTextAttribute class can be applied in a class.
You can apply the XmlTextAttribute to public fields and public read/write properties that return primitive and enumeration types.
You can apply the XmlTextAttribute to a field or property that returns an array of strings. You can also apply the attribute to an array of type Object but you must set the Type property to string. In that case, any strings inserted into the array are serialized as XML text.
The XmlTextAttribute can also be applied to a field that returns an XmlNode or an array of XmlNode objects.
By default, the XmlSerializer serializes a class member as an XML element. However, if you apply the XmlTextAttribute to a member, the XmlSerializer translates its value into XML text. This means that the value is encoded into the content of an XML element.
The XML Schema Definition Tool (Xsd.exe) occasionally generates the XmlTextAttribute when creating classes from an XML Schema definition (XSD) file. This occurs when the schema contains a complexType with mixed content; in that case, the corresponding class contains a member that returns a string array to which the XmlTextAttribute is applied. For example, when the Xml Schema Definition tool processes this schema:
<xs:schema attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace=""
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="LinkList" type="LinkList" />
<xs:complexType name="LinkList" mixed="true">
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="1" name="id" type="xs:int" />
<xs:element minOccurs="0" maxOccurs="1" name="name" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="next" type="LinkList" />
</xs:sequence>
</xs:complexType>
</xs:schema>
the following class is generated (extra spaces and remarks have been removed):
For more information about using attributes, see Extending Metadata Using Attributes.
Note |
|---|
You can use the word XmlText in your code instead of the longer XmlTextAttribute. |
#using <System.Xml.dll> #using <System.dll> using namespace System; using namespace System::Xml::Serialization; using namespace System::IO; public ref class Group1 { public: // The XmlTextAttribute with type set to string informs the // XmlSerializer that strings should be serialized as XML text. [XmlText(String::typeid)] [XmlElement(Int32::typeid)] [XmlElement(Double::typeid)] array<Object^>^All; Group1() { array<Object^>^temp = {321,"One",2,3.0,"Two"}; All = temp; } }; public enum class GroupType { Small, Medium, Large }; public ref class Group2 { public: [XmlText(Type=GroupType::typeid)] GroupType Type; }; public ref class Group3 { public: [XmlText(Type=DateTime::typeid)] DateTime CreationTime; Group3() { CreationTime = DateTime::Now; } }; public ref class Test { public: static void main() { Test^ t = gcnew Test; t->SerializeArray( "XmlText1.xml" ); t->SerializeEnum( "XmlText2.xml" ); t->SerializeDateTime( "XmlText3.xml" ); } private: void SerializeArray( String^ filename ) { XmlSerializer^ ser = gcnew XmlSerializer( Group1::typeid ); Group1^ myGroup1 = gcnew Group1; TextWriter^ writer = gcnew StreamWriter( filename ); ser->Serialize( writer, myGroup1 ); writer->Close(); } void SerializeEnum( String^ filename ) { XmlSerializer^ ser = gcnew XmlSerializer( Group2::typeid ); Group2^ myGroup = gcnew Group2; myGroup->Type = GroupType::Medium; TextWriter^ writer = gcnew StreamWriter( filename ); ser->Serialize( writer, myGroup ); writer->Close(); } void SerializeDateTime( String^ filename ) { XmlSerializer^ ser = gcnew XmlSerializer( Group3::typeid ); Group3^ myGroup = gcnew Group3; TextWriter^ writer = gcnew StreamWriter( filename ); ser->Serialize( writer, myGroup ); writer->Close(); } }; int main() { Test::main(); }
Available since 8
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
XmlAttributeOverrides
XmlAttributes
XmlSerializer
XmlText
XmlAttributes
System.Xml.Serialization Namespace
Introducing XML Serialization
How to: Specify an Alternate Element Name for an XML Stream
Controlling XML Serialization Using Attributes
Examples of XML Serialization
XML Schema Definition Tool (Xsd.exe)





