Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

XmlAttributes.Xmlns Property

Gets or sets a value that specifies whether to keep all namespace declarations when an object containing a member that returns an XmlSerializerNamespaces object is overridden.

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

'Declaration
Public Property Xmlns As Boolean
'Usage
Dim instance As XmlAttributes
Dim value As Boolean

value = instance.Xmlns

instance.Xmlns = value
/** @property */
public boolean get_Xmlns ()

/** @property */
public void set_Xmlns (boolean value)

public function get Xmlns () : boolean

public function set Xmlns (value : boolean)

Property Value

true if the namespace declarations should be kept; otherwise, false.

The following example contains a class named Student. The class contains a member named MyNamespaces that returns an XmlSerializerNamespaces object. The example creates an XmlAttributes object that is added to an instance of the XmlAttributeOverrides class. The Xmlns property is set to true, which instructs the XmlSerializer to preserve the namespaces when the serialization of the Student object is overridden.

Imports System
Imports System.IO
Imports System.Xml
Imports System.Xml.Serialization
 
Public Class Student
   <XmlAttributeAttribute()> _
   Public Name As String

   <XmlNamespaceDeclarationsAttribute()> _   
   Public myNamespaces As XmlSerializerNamespaces
End Class 'Student
 

Public Class Run
   
   Public Shared Sub Main()
      Dim test As New Run()
      test.SerializeStudent("Student_v.xml")
      test.DeserializeStudent("Student_v.xml")
   End Sub 
   
   
   Public Sub SerializeStudent(filename As String)
      Dim atts As New XmlAttributes()
      ' Set to true to preserve namespaces, or false to ignore them.
      atts.Xmlns = True
      
      Dim xover As New XmlAttributeOverrides()
      ' Add the XmlAttributes and specify the name of 
      ' the element containing namespaces.
      xover.Add(GetType(Student), "myNamespaces", atts)
      ' Create the XmlSerializer using the 
      ' XmlAttributeOverrides object.
      Dim xser As New XmlSerializer(GetType(Student), xover)
      
      Dim myStudent As New Student()
      Dim ns As New XmlSerializerNamespaces()
      ns.Add("myns1", "http://www.cpandl.com")
      ns.Add("myns2", "http://www.cohowinery.com")
      myStudent.myNamespaces = ns
      myStudent.Name = "Student1"
      
      Dim fs As New FileStream(filename, FileMode.Create)
      
      xser.Serialize(fs, myStudent)
      fs.Close()
   End Sub 
       
   Private Sub DeserializeStudent(filename As String)
      Dim atts As New XmlAttributes()
      ' Set to true to preserve namespaces, or false to ignore them.
      atts.Xmlns = True
      
      Dim xover As New XmlAttributeOverrides()
      ' Add the XmlAttributes and specify the name 
      ' of the element containing namespaces.
      xover.Add(GetType(Student), "myNamespaces", atts)
      
      ' Create the XmlSerializer using the 
      ' XmlAttributeOverrides object.
      Dim xser As New XmlSerializer(GetType(Student), xover)
      
      Dim fs As New FileStream(filename, FileMode.Open)
      
      Dim myStudent As Student
      myStudent = CType(xser.Deserialize(fs), Student)
      fs.Close()
      
      ' Use the ToArray method to get an array 
      ' of XmlQualifiedName objects.
      Dim qNames As XmlQualifiedName() = _
           myStudent.myNamespaces.ToArray()
      Dim i As Integer
      For i = 0 To qNames.Length - 1
         Console.WriteLine("{0}:{1}", _
              qNames(i).Name, qNames(i).Namespace)
      Next i
   End Sub 
End Class 

import System.*;
import System.IO.*;
import System.Xml.*;
import System.Xml.Serialization.*;
public class Student
{
    /** @attribute XmlAttributeAttribute()
     */
    public String name;

    /** @attribute XmlNamespaceDeclarationsAttribute()
     */
    public XmlSerializerNamespaces myNamespaces;
} //Student

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

    public void SerializeStudent(String fileName)
    {
        XmlAttributes atts = new XmlAttributes();
        // Set to true to preserve namespaces, 
        // or false to ignore them.
        atts.set_Xmlns(true);

        XmlAttributeOverrides xOver = new XmlAttributeOverrides();
        // Add the XmlAttributes and specify the name of the element 
        // containing namespaces.
        xOver.Add(Student.class.ToType(), "myNamespaces", atts);
        // Create the XmlSerializer using the 
        // XmlAttributeOverrides object.
        XmlSerializer xSer = new XmlSerializer(Student.class.ToType(),
            xOver);

        Student myStudent = new Student();
        XmlSerializerNamespaces ns = new XmlSerializerNamespaces();
        ns.Add("myns1", "http://www.cpandl.com");
        ns.Add("myns2", "http://www.cohowinery.com");
        myStudent.myNamespaces = ns;
        myStudent.name = "Student1";

        FileStream fs = new FileStream(fileName, FileMode.Create);

        xSer.Serialize(fs, myStudent);
        fs.Close();
    } //SerializeStudent

    private void DeserializeStudent(String fileName)
    {
        XmlAttributes atts = new XmlAttributes();
        // Set to true to preserve namespaces, or false to ignore them.
        atts.set_Xmlns(true);

        XmlAttributeOverrides xOver = new XmlAttributeOverrides();
        // Add the XmlAttributes and specify the name of the 
        // element containing namespaces.
        xOver.Add(Student.class.ToType(), "myNamespaces", atts);
        // Create the XmlSerializer using the 
        // XmlAttributeOverrides object.
        XmlSerializer xSer = new XmlSerializer(Student.class.ToType(), xOver);

        FileStream fs = new FileStream(fileName, FileMode.Open);

        Student myStudent;
        myStudent = (Student)xSer.Deserialize(fs);
        fs.Close();
        // Use the ToArray method to get an array of 
        // XmlQualifiedName objects.
        XmlQualifiedName qNames[] = myStudent.myNamespaces.ToArray();
        for (int i = 0; i < qNames.get_Length(); i++) {
            Console.WriteLine("{0}:{1}", qNames[i].get_Name(), qNames[i].
                get_Namespace());
        }
    } //DeserializeStudent
} //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
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.