XmlTextAttribute Class
Microsoft Silverlight will reach end of support after October 2021. Learn more.
Indicates to the XmlSerializer that the member must be treated as XML text when the class that contains it is serialized or deserialized.
Inheritance Hierarchy
System.Object
System.Attribute
System.Xml.Serialization.XmlTextAttribute
Namespace: System.Xml.Serialization
Assembly: System.Xml (in System.Xml.dll)
Syntax
'Declaration
<AttributeUsageAttribute(AttributeTargets.Property Or AttributeTargets.Field Or AttributeTargets.Parameter Or AttributeTargets.ReturnValue)> _
Public Class XmlTextAttribute _
Inherits Attribute
[AttributeUsageAttribute(AttributeTargets.Property|AttributeTargets.Field|AttributeTargets.Parameter|AttributeTargets.ReturnValue)]
public class XmlTextAttribute : Attribute
The XmlTextAttribute type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") .gif "Supported by Silverlight for Windows Phone") .gif "Supported by Xbox 360") |
XmlTextAttribute() | Initializes a new instance of the XmlTextAttribute class. |
|
XmlTextAttribute(Type) | Initializes a new instance of the XmlTextAttribute class. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
DataType | Gets or sets the XML Schema definition (XSD) language data type of the text generated by the XmlSerializer. |
|
Type | Gets or sets the type of the member. |
Top
Methods
| Name | Description | |
|---|---|---|
|
Equals | Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.) |
.gif "Protected method") |
Finalize | Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
|
GetHashCode | Returns the hash code for this instance. (Inherited from Attribute.) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
Match | When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.) |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Top
Remarks
The XmlTextAttribute belongs to a family of attributes that controls how the XmlSerializer serializes and deserializes an object (through its Serialize and Deserialize methods).
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.
.gif "Note") Note: |
|---|
You can use the word XmlText in your code instead of the longer XmlTextAttribute. |
Version Information
Silverlight
Supported in: 5, 4, 3
Silverlight for Windows Phone
Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0
XNA Framework
Supported in: Xbox 360, Windows Phone OS 7.0
Platforms
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also