XmlElementAttribute.DataType Property

Gets or sets the XML Schema definition (XSD) data type of the XML element generated by the XmlSerializer.

Namespace: System.Xml.Serialization
Assembly: System.Xml (in system.xml.dll)

public string DataType { get; set; }
/** @property */
public String get_DataType ()

/** @property */
public void set_DataType (String value)

public function get DataType () : String

public function set DataType (value : String)

Property Value

An XML Schema data type, as defined by the World Wide Web Consortium (www.w3.org) document named "XML Schema Part 2: Datatypes".

Exception typeCondition

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 XmlElementAttribute 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 XmlElementAttribute with the DataType set to "date" or "time".

For every XML Schema type that is mapped to a string, apply the XmlElementAttribute with its DataType property set to the XML Schema type. It is possible that this can change the serialization format, not only the schema for the member.

NoteNote

The property is case-sensitive, so you must set it exactly to one of the XML Schema data types.

NoteNote

Passing binary data as an XML element is more efficient than passing it as an XML Schema attribute.

For more information about XML data types, see the World Wide Web Consortium (www.w3.org) document named "XML Schema Part 2: Datatypes".

XSD data type

.NET data type

anyURI

String

base64Binary

Array of Byte objects

boolean

Boolean

byte

SByte

date

DateTime

dateTime

DateTime

decimal

Decimal

double

Double

ENTITY

String

ENTITIES

String

float

Single

gDay

String

gMonth

String

gMonthDay

String

gYear

String

gYearMonth

String

hexBinary

Array of Byte objects

ID

String

IDREF

String

IDREFS

String

int

Int32

integer

String

language

String

long

Int64

Name

String

NCName

String

negativeInteger

String

NMTOKEN

String

NMTOKENS

String

normalizedString

String

nonNegativeInteger

String

nonPositiveInteger

String

NOTATION

String

positiveInteger

String

QName

XmlQualifiedName

duration

String

string

String

short

Int16

time

DateTime

token

String

unsignedByte

Byte

unsignedInt

UInt32

unsignedLong

UInt64

unsignedShort

UInt16

The following example serializes a class named Group that contains a field named ExtraInfo, which returns an ArrayList. The example applies two instances of the XmlElementAttribute to the field and specifies different DataType values for each instance. Each instance enables the XmlSerializer to serialize the specified types inserted into the array.

using System;
using System.Collections;
using System.IO;
using System.Xml.Serialization;

public class Group
{
   /* Apply two XmlElementAttributes to the field. Set the DataType
      to string an int to allow the ArrayList to accept 
      both types. The Namespace is also set to different values
      for each type. */ 
   [XmlElement(DataType = "string",
   Type = typeof(string),
   Namespace = "http://www.cpandl.com"),
   XmlElement(DataType = "int", 
   Namespace = "http://www.cohowinery.com",
   Type = typeof(int))]
   public ArrayList ExtraInfo;
}

public class Run
{
    public static void Main()
    {
       Run test = new Run();
       test.SerializeObject("ElementTypes.xml");
          }

    public void SerializeObject(string filename)
    {
      // A TextWriter is needed to write the file.
      TextWriter writer = new StreamWriter(filename);

      // Create the XmlSerializer using the XmlAttributeOverrides.
      XmlSerializer s = 
      new XmlSerializer(typeof(Group));

      // Create the object to serialize.
      Group myGroup = new Group();

      /* Add a string and an integer to the ArrayList returned
         by the ExtraInfo field. */
      myGroup.ExtraInfo = new ArrayList();
      myGroup.ExtraInfo.Add("hello");
      myGroup.ExtraInfo.Add(100);

      // Serialize the object and close the TextWriter.
      s.Serialize(writer,myGroup);
      writer.Close();
   }
}


import System.*;
import System.Collections.*;
import System.IO.*;
import System.Xml.Serialization.*;

public class Group
{
    /* Apply two XmlElementAttributes to the field. Set the DataType
       to string an int to allow the ArrayList to accept 
       both types. The Namespace is also set to different values
       for each type. */
    /** @attribute XmlElement(DataType = "string",
        Type = String.class, Namespace = "http://www.cpandl.com")
        @attribute XmlElement(DataType = "int",
        Namespace = "http://www.cohowinery.com", Type = int.class)
     */
    public ArrayList extraInfo;
} //Group

public class Run
{
    public static void main(String[] args)
    {
        Run test = new Run();
        test.SerializeObject("ElementTypes.xml");
    } //main

    public void SerializeObject(String fileName)
    {
        // A TextWriter is needed to write the file.
        TextWriter writer = new StreamWriter(fileName);

        // Create the XmlSerializer using the XmlAttributeOverrides.
        XmlSerializer s = new XmlSerializer(Group.class.ToType());
        // Create the object to serialize.
        Group myGroup = new Group();

        /* Add a string and an integer to the ArrayList returned
           by the extraInfo field. */
        myGroup.extraInfo = new ArrayList();
        myGroup.extraInfo.Add("hello");
        myGroup.extraInfo.Add((Int32)100);
        // Serialize the object and close the TextWriter.
        s.Serialize(writer, myGroup);
        writer.Close();
    } //SerializeObject
} //Run

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.

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

Community Additions

ADD
Show: