SoapAttributeAttribute.DataType Property
Gets or sets the XML Schema definition language (XSD) data type of the SOAP attribute generated by the XmlSerializer.
Assembly: System.Xml (in System.Xml.dll)
Property Value
Type: System.StringAn XML Schema data type, as defined by the World Wide Web Consortium (www.w3.org) document named "XML Schema Part 2: Datatypes".
| Exception | Condition |
|---|---|
| Exception | The XML Schema data type you have specified cannot be mapped to the .NET data type. |
The following table lists the XML Schema simple data types with their.NET equivalents.
For the XML Schema base64Binary and hexBinary data types, use an array of Byte structures, and apply a SoapAttributeAttribute with the DataType set to "base64Binary" or "hexBinary", as appropriate. For the XML Schema time and date data types, use the DateTime type and apply the SoapAttributeAttribute with the DataType set to "date" or "time".
For every XML Schema data type that is mapped to a string, apply the SoapAttributeAttribute with its DataType property set to the XML Schema data type. Note that this does not change the serialization format, only the schema for the member.
Note |
|---|
The property is case-sensitive, so you must set it exactly to one of the XML Schema data types. |
Note |
|---|
Passing binary data as an XML element is more efficient then passing it as an XML attribute. |
For more information about XML Schema data types, see the World Wide Consortium (www.w3.org) document named "XML Schema Part 2: Datatypes".
XSD data type | .NET data type |
|---|---|
anyURI | |
base64Binary | Array of Byte objects |
boolean | |
byte | |
date | |
dateTime | |
decimal | |
double | |
ENTITY | |
ENTITIES | |
float | |
gDay | |
gMonth | |
gMonthDay | |
gYear | |
gYearMonth | |
hexBinary | Array of Byte objects |
ID | |
IDREF | |
IDREFS | |
int | |
integer | |
language | |
long | |
Name | |
NCName | |
negativeInteger | |
NMTOKEN | |
NMTOKENS | |
normalizedString | |
nonNegativeInteger | |
nonPositiveInteger | |
NOTATION | |
positiveInteger | |
QName | |
duration | |
string | |
short | |
time | |
token | |
unsignedByte | |
unsignedInt | |
unsignedLong | |
unsignedShort |
The following example serializes a class that contains several fields to which a SoapAttributeAttribute is applied. The DataType property is set for the GroupNumber and the Today fields.
using System; using System.IO; using System.Text; using System.Xml; using System.Xml.Serialization; using System.Xml.Schema; [SoapInclude(typeof(Vehicle))] public class Group { [SoapAttribute (Namespace = "http://www.cpandl.com")] public string GroupName; [SoapAttribute(DataType = "base64Binary")] public Byte [] GroupNumber; [SoapAttribute(DataType = "date", AttributeName = "CreationDate")] public DateTime Today; [SoapElement(DataType = "nonNegativeInteger", ElementName = "PosInt")] public string PostitiveInt; public Vehicle GroupVehicle; } public class Vehicle { public string licenseNumber; } public class Run { public static void Main() { Run test = new Run(); test.SerializeObject("SoapAtts.xml"); test.DeserializeObject("SoapAtts.xml"); } public void SerializeObject(string filename) { // Create an instance of the XmlSerializer class that // can generate encoded SOAP messages. XmlSerializer mySerializer = ReturnSOAPSerializer(); Group myGroup=MakeGroup(); // Writing the file requires a TextWriter. XmlTextWriter writer = new XmlTextWriter(filename, Encoding.UTF8); writer.Formatting = Formatting.Indented; writer.WriteStartElement("wrapper"); // Serialize the class, and close the TextWriter. mySerializer.Serialize(writer, myGroup); writer.WriteEndElement(); writer.Close(); } private Group MakeGroup(){ // Create an instance of the class that will be serialized. Group myGroup = new Group(); // Set the object properties. myGroup.GroupName = ".NET"; Byte [] hexByte = new Byte[2]{Convert.ToByte(100), Convert.ToByte(50)}; myGroup.GroupNumber = hexByte; DateTime myDate = new DateTime(2002,5,2); myGroup.Today = myDate; myGroup.PostitiveInt= "10000"; myGroup.GroupVehicle = new Vehicle(); myGroup.GroupVehicle.licenseNumber="1234"; return myGroup; } public void DeserializeObject(string filename) { // Create an instance of the XmlSerializer class that // can generate encoded SOAP messages. XmlSerializer mySerializer = ReturnSOAPSerializer(); // Reading the file requires an XmlTextReader. XmlTextReader reader= new XmlTextReader(filename); reader.ReadStartElement("wrapper"); // Deserialize and cast the object. Group myGroup; myGroup = (Group) mySerializer.Deserialize(reader); reader.ReadEndElement(); reader.Close(); } private XmlSerializer ReturnSOAPSerializer(){ // Create an instance of the XmlSerializer class. XmlTypeMapping myMapping = (new SoapReflectionImporter().ImportTypeMapping (typeof(Group))); return new XmlSerializer(myMapping); } }
Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Note