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.
Imports System Imports System.IO Imports System.Text Imports System.Xml Imports System.Xml.Serialization Imports System.Xml.Schema <SoapInclude(GetType(Vehicle))> _ Public Class Group <SoapAttribute (Namespace:= "http:'www.cpandl.com")> _ Public GroupName As String <SoapAttribute(DataType:= "base64Binary")> _ Public GroupNumber() As Byte <SoapAttribute(DataType:= "date", AttributeName:= "CreationDate")> _ Public Today As DateTime <SoapElement(DataType:= "nonNegativeInteger", _ ElementName:= "PosInt")> _ Public PostitiveInt As String Public GroupVehicle As Vehicle End Class Public Class Vehicle Public licenseNumber As String End Class Public Class Run Shared Sub Main() Dim test As Run = New Run() test.SerializeObject("SoapAtts.xml") test.DeserializeObject("SoapAtts.xml") End Sub Public Sub SerializeObject(filename As String) ' Create an instance of the XmlSerializer Class that ' can generate encoded SOAP messages. Dim mySerializer As XmlSerializer = ReturnSOAPSerializer() Dim myGroup As Group = MakeGroup() ' Writing the file requires a TextWriter. Dim writer As XmlTextWriter = _ 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() End Sub Private Function MakeGroup() As Group ' Create an instance of the Class that will be serialized. Dim myGroup As Group = New Group() ' Set the object properties. myGroup.GroupName = ".NET" Dim hexByte() As Byte= New Byte(1){Convert.ToByte(100), _ Convert.ToByte(50)} myGroup.GroupNumber = hexByte Dim myDate As DateTime = New DateTime(2002,5,2) myGroup.Today = myDate myGroup.PostitiveInt= "10000" myGroup.GroupVehicle = New Vehicle() myGroup.GroupVehicle.licenseNumber="1234" return myGroup End Function Public Sub DeserializeObject(filename As String) ' Create an instance of the XmlSerializer Class that ' can generate encoded SOAP messages. Dim mySerializer As XmlSerializer = ReturnSOAPSerializer() ' Reading the file requires an XmlTextReader. Dim reader As XmlTextReader = _ New XmlTextReader(filename) reader.ReadStartElement("wrapper") ' Deserialize and cast the object. Dim myGroup As Group myGroup = _ CType(mySerializer.Deserialize(reader), Group) reader.ReadEndElement() reader.Close() End Sub private Function ReturnSOAPSerializer() As XmlSerializer ' Create an instance of the XmlSerializer Class. Dim myMapping As XmlTypeMapping = _ (New SoapReflectionImporter().ImportTypeMapping _ (GetType(Group))) return New XmlSerializer(myMapping) End Function End Class
Available since 1.1
