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::String^An 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.dll> #using <System.Xml.dll> using namespace System; using namespace System::IO; using namespace System::Text; using namespace System::Xml; using namespace System::Xml::Serialization; using namespace System::Xml::Schema; //using namespace System::Runtime::Remoting::Metadata; public ref class Vehicle { public: String^ licenseNumber; }; [SoapInclude(Vehicle::typeid)] public ref class Group { public: [SoapAttributeAttribute(Namespace="http://www.cpandl.com")] String^ GroupName; [SoapAttributeAttribute(DataType="base64Binary")] array<Byte>^GroupNumber; [SoapAttributeAttribute(DataType="date",AttributeName="CreationDate")] DateTime Today; [SoapElement(DataType="nonNegativeInteger",ElementName="PosInt")] String^ PostitiveInt; Vehicle^ GroupVehicle; }; public ref class Run { 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 = gcnew 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 = gcnew Group; // Set the Object* properties. myGroup->GroupName = ".NET"; array<Byte>^hexByte = {Convert::ToByte( 100 ),Convert::ToByte( 50 )}; myGroup->GroupNumber = hexByte; DateTime myDate = DateTime(2002,5,2); myGroup->Today = myDate; myGroup->PostitiveInt = "10000"; myGroup->GroupVehicle = gcnew 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 = gcnew XmlTextReader( filename ); reader->ReadStartElement( "wrapper" ); // Deserialize and cast the Object*. Group^ myGroup; myGroup = safe_cast<Group^>(mySerializer->Deserialize( reader )); reader->ReadEndElement(); reader->Close(); } private: XmlSerializer^ ReturnSOAPSerializer() { // Create an instance of the XmlSerializer class. XmlTypeMapping^ myMapping = (gcnew SoapReflectionImporter)->ImportTypeMapping( Group::typeid ); return gcnew XmlSerializer( myMapping ); } }; int main() { Run^ test = gcnew Run; test->SerializeObject( "SoapAtts.xml" ); test->DeserializeObject( "SoapAtts.xml" ); }
Available since 1.1
