Export (0) Print
Expand All

XmlSerializerNamespaces Class

Contains the XML namespaces and prefixes that the XmlSerializer uses to generate qualified names in an XML-document instance.

For a list of all members of this type, see XmlSerializerNamespaces Members.

System.Object
   System.Xml.Serialization.XmlSerializerNamespaces

[Visual Basic]
Public Class XmlSerializerNamespaces
[C#]
public class XmlSerializerNamespaces
[C++]
public __gc class XmlSerializerNamespaces
[JScript]
public class XmlSerializerNamespaces

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Remarks

The XmlSerializerNamespaces contains a collection of XML namespaces, each with an associated prefix. The XmlSerializer uses an instance of the XmlSerializerNamespaces class to create qualified names in an XML document.

XML namespaces contained by the XmlSerializerNamespaces must conform to the www.w3.org specification named Namespaces in XML.

XML namespaces provide a method for qualifying the names of XML elements and XML attributes in XML documents. A qualified name consists of a prefix and a local name, separated by a colon. The prefix functions only as a placeholder; it is mapped to a URI that specifies a namespace. The combination of the universally-managed URI namespace and the local name produces a name that is guaranteed to be universally unique.

To create qualified names in an XML document:

  1. Create an XmlSerializerNamespaces instance.
  2. Add each prefix and namespace pair that you want to the instance.
  3. Apply the appropriate .NET attribute to each property or class that the XmlSerializer will serialize into an XML document. The available attributes are: XmlArrayAttribute, XmlArrayItemAttribute, XmlAttributeAttribute, XmlElementAttribute, XmlRootAttribute, XmlTypeAttribute.
  4. Set the Namespace property of each attribute to one of the namespace values from the XmlSerializerNamespaces object.
  5. Pass the XmlSerializerNamespaces to the Serialize method of the XmlSerializer.

Example

[Visual Basic, C#, C++] The following example creates an XmlSerializerNamespaces object, and adds two prefix-namespaces pairs to it. The example then passes the XmlSerializerNamespaces to the Serialize method, which serializes a Books object into an XML document. Using the XmlSerializerNamespaces object, the Serialize method qualifies each XML element and attribute with one of the two namespaces.

[Visual Basic] 
Imports System
Imports System.IO
Imports System.Xml
Imports System.Xml.Serialization


Public Class Run
    
    Public Shared Sub Main()
        Dim test As New Run()
        test.SerializeObject("XmlNamespaces.xml")
    End Sub    
    
    Public Sub SerializeObject(ByVal filename As String)
        Dim s As New XmlSerializer(GetType(Books))
        ' Writing a file requires a TextWriter.
        Dim t As New StreamWriter(filename)
        
        ' Create an XmlSerializerNamespaces object and add two
        ' prefix-namespace pairs. 
        Dim ns As New XmlSerializerNamespaces()
        ns.Add("books", "http://www.cpandl.com")
        ns.Add("money", "http://www.cohowinery.com")
        
        ' Create a Book instance.
        Dim b As New Book()
        b.TITLE = "A Book Title"
        Dim p As New Price()
        p.price = CDec(9.95)
        p.currency = "US Dollar"
        b.PRICE = p
        Dim bks As New Books()
        bks.Book = b
        s.Serialize(t, bks, ns)
        t.Close()
    End Sub
End Class

Public Class Books
    <XmlElement(Namespace := "http://www.cohowinery.com")> _
    Public Book As Book
End Class

<XmlType(Namespace := "http://www.cpandl.com")> _
Public Class Book
    <XmlElement(Namespace := "http://www.cpandl.com")> _
    Public TITLE As String

    <XmlElement(Namespace := "http://www.cohowinery.com")> _
    Public PRICE As Price
End Class

Public Class Price
    <XmlAttribute(Namespace := "http://www.cpandl.com")> _
    Public currency As String
    
    <XmlElement(Namespace := "http://www.cohowinery.com")> _
    Public price As Decimal
End Class


[C#] 
using System;
using System.IO;
using System.Xml;
using System.Xml.Serialization;
 
public class Run
{
   public static void Main()
   {
      Run test = new Run();
      test.SerializeObject("XmlNamespaces.xml");
   }
 
   public void SerializeObject(string filename)
   {
      XmlSerializer s = new XmlSerializer(typeof(Books));
      // Writing a file requires a TextWriter.
      TextWriter t = new StreamWriter(filename);

      /* Create an XmlSerializerNamespaces object and add two
      prefix-namespace pairs. */
      XmlSerializerNamespaces ns = new XmlSerializerNamespaces();
      ns.Add("books", "http://www.cpandl.com");
      ns.Add("money", "http://www.cohowinery.com");

      // Create a Book instance.
      Book b = new Book();
      b.TITLE = "A Book Title";
      Price p = new Price();
      p.price = (decimal) 9.95;
      p.currency = "US Dollar";
      b.PRICE = p;
      Books bks = new Books();
      bks.Book = b;
      s.Serialize(t,bks,ns);
      t.Close();
   }
}

public class Books
{
   [XmlElement(Namespace = "http://www.cohowinery.com")]
   public Book Book;
}

[XmlType(Namespace ="http://www.cpandl.com")]
public class Book
{
   [XmlElement(Namespace = "http://www.cpandl.com")]
   public string TITLE;
   [XmlElement(Namespace ="http://www.cohowinery.com")]
   public Price PRICE;
}

public class Price
{
   [XmlAttribute(Namespace = "http://www.cpandl.com")]
   public string currency;
   [XmlElement(Namespace = "http://www.cohowinery.com")]
   public decimal price;
}


[C++] 
#using <mscorlib.dll>
#using <System.Xml.dll>
using namespace System;
using namespace System::IO;
using namespace System::Xml;
using namespace System::Xml::Serialization;

public __gc class Price
{
public:
   [XmlAttributeAttribute(Namespace = S"http://www.cpandl.com")]
   String* currency;
   [XmlElement(Namespace = S"http://www.cohowinery.com")]
   Decimal price;
};
 
[XmlType(Namespace =S"http://www.cpandl.com")]
public __gc class Book
{
public:
   [XmlElement(Namespace = S"http://www.cpandl.com")]
   String* TITLE;
   [XmlElement(Namespace =S"http://www.cohowinery.com")]
   Price* PRICE;
};

public __gc class Books
{
public:
   [XmlElement(Namespace = S"http://www.cohowinery.com")]
   Book* Book;
};

public __gc class Run
{
public:
   static void main()
   {
      Run* test = new Run();
      test->SerializeObject(S"XmlNamespaces.xml");
   }
 
   void SerializeObject(String* filename)
   {
      XmlSerializer* s = new XmlSerializer(__typeof(Books));
      // Writing a file requires a TextWriter.
      TextWriter* t = new StreamWriter(filename);

      /* Create an XmlSerializerNamespaces object and add two
      prefix-namespace pairs. */
      XmlSerializerNamespaces* ns = new XmlSerializerNamespaces();
      ns->Add(S"books", S"http://www.cpandl.com");
      ns->Add(S"money", S"http://www.cohowinery.com");

      // Create a Book instance.
      Book* b = new Book();
      b->TITLE = S"A Book Title";
      Price* p = new Price();
      p->price = (Decimal) 9.95;
      p->currency = S"US Dollar";
      b->PRICE = p;
      Books* bks = new Books();
      bks->Book = b;
      s->Serialize(t,bks,ns);
      t->Close();
   }
};

int main()
{
   Run::main();
}

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Namespace: System.Xml.Serialization

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, .NET Compact Framework

Assembly: System.Xml (in System.Xml.dll)

See Also

XmlSerializerNamespaces Members | System.Xml.Serialization Namespace

Show:
© 2014 Microsoft