XmlAnyAttributeAttribute Class
Assembly: System.Xml (in system.xml.dll)
'Declaration <AttributeUsageAttribute(AttributeTargets.Property Or AttributeTargets.Field Or AttributeTargets.Parameter Or AttributeTargets.ReturnValue, AllowMultiple:=False)> _ Public Class XmlAnyAttributeAttribute Inherits Attribute 'Usage Dim instance As XmlAnyAttributeAttribute
/** @attribute AttributeUsageAttribute(AttributeTargets.Property|AttributeTargets.Field|AttributeTargets.Parameter|AttributeTargets.ReturnValue, AllowMultiple=false) */ public class XmlAnyAttributeAttribute extends Attribute
AttributeUsageAttribute(AttributeTargets.Property|AttributeTargets.Field|AttributeTargets.Parameter|AttributeTargets.ReturnValue, AllowMultiple=false) public class XmlAnyAttributeAttribute extends Attribute
Use the XmlAnyAttributeAttribute to contain arbitrary data (as XML attributes) that is sent as part of an XML document, such as, metadata sent as part of the document.
Apply the XmlAnyAttributeAttribute to a field that returns an array of XmlAttribute or XmlNode objects. When the Deserialize method of the XmlSerializer class is called, all XML attributes that do not have a corresponding member in the class being deserialized are collected in the array. After deserialization, you can iterate through the collection of XmlAttribute items to process the data.
The UnknownNode and UnknownAttribute events of the XmlSerializer do not occur if you apply the XmlAnyAttributeAttribute to a member of a class.
Note |
|---|
| You can use the word XmlAnyAttribute in your code instead of the longer XmlAnyAttributeAttribute. |
For more information about using attributes, see Extending Metadata Using Attributes.
The following example collects all unknown attributes into an array of XmlAttribute objects. To try the example, create a file named UnknownAttributes.xml that contains the following XML:
<?xml version="1.0" encoding="utf-8"?> <Group xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" GroupType = 'Technical' GroupNumber = '42' GroupBase = 'Red'> <GroupName>MyGroup</GroupName> </Group>
Imports System Imports System.IO Imports System.Xml.Serialization Imports System.Xml Public Class Group Public GroupName As String ' The UnknownAttributes array will be used to collect all unknown ' attributes found when deserializing. <XmlAnyAttribute> _ Public UnknownAttributes()As XmlAttribute End Class Public Class Test Shared Sub Main() Dim t As Test = New Test() ' Deserialize the file containing unknown attributes. t.DeserializeObject("UnknownAttributes.xml") End Sub Private Sub DeserializeObject(filename As String) Dim ser As XmlSerializer = New XmlSerializer(GetType(Group)) ' A FileStream is needed to read the XML document. Dim fs As FileStream = New FileStream(filename, FileMode.Open) Dim g As Group = CType(ser.Deserialize(fs), Group) fs.Close() ' Write out the data, including unknown attributes. Console.WriteLine(g.GroupName) Console.WriteLine("Number of unknown attributes: " & _ g.UnknownAttributes.Length) Dim xAtt As XmlAttribute for each xAtt in g.UnknownAttributes Console.WriteLine(xAtt.Name & ": " & xAtt.InnerXml) Next ' Serialize the object again with the attributes added. Me.SerializeObject("AttributesAdded.xml",g) End Sub Private Sub SerializeObject(filename As String, g As object) Dim ser As XmlSerializer = New XmlSerializer(GetType(Group)) DIm writer As TextWriter = New StreamWriter(filename) ser.Serialize(writer, g) writer.Close() End Sub End Class
import System.*;
import System.IO.*;
import System.Xml.Serialization.*;
import System.Xml.*;
public class Group
{
public String groupName;
// The UnknownAttributes array will be used to collect all unknown
// attributes found when deserializing.
/** @attribute XmlAnyAttribute()
*/
public XmlAttribute xAttributes[];
} //Group
public class Test
{
public static void main(String[] args)
{
Test t = new Test();
// Deserialize the file containing unknown attributes.
t.DeserializeObject("UnknownAttributes.xml");
} //main
private void DeserializeObject(String fileName)
{
XmlSerializer ser = new XmlSerializer(Group.class.ToType());
// A FileStream is needed to read the XML document.
FileStream fs = new FileStream(fileName, FileMode.Open);
Group g = (Group)ser.Deserialize(fs);
fs.Close();
// Write out the data, including unknown attributes.
Console.WriteLine(g.groupName);
Console.WriteLine("Number of unknown attributes: "
+ g.xAttributes.get_Length());
for (int iCtr = 0; iCtr < g.xAttributes.get_Count(); iCtr++) {
XmlAttribute xAtt = (XmlAttribute)g.xAttributes.get_Item(iCtr);
Console.WriteLine(xAtt.get_Name() + ": " + xAtt.get_InnerXml());
}
// Serialize the object again with the attributes added.
this.SerializeObject("AttributesAdded.xml", g);
} //DeserializeObject
private void SerializeObject(String fileName, Object g)
{
XmlSerializer ser = new XmlSerializer(Group.class.ToType());
TextWriter writer = new StreamWriter(fileName);
ser.Serialize(writer, g);
writer.Close();
} //SerializeObject
} //Test
Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.
Reference
XmlAnyAttributeAttribute MembersSystem.Xml.Serialization Namespace
XmlAnyElementAttribute
XmlSerializer
XmlAttributes
Other Resources
Introducing XML SerializationHow 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)
Note