XmlNamespaceDeclarationsAttribute Clase

Definición

public ref class XmlNamespaceDeclarationsAttribute : Attribute

[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.Property | System.AttributeTargets.ReturnValue, AllowMultiple=false)]
public class XmlNamespaceDeclarationsAttribute : Attribute

[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.Property | System.AttributeTargets.ReturnValue)]
public class XmlNamespaceDeclarationsAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.Property | System.AttributeTargets.ReturnValue, AllowMultiple=false)>]
type XmlNamespaceDeclarationsAttribute = class
    inherit Attribute

[<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.Property | System.AttributeTargets.ReturnValue)>]
type XmlNamespaceDeclarationsAttribute = class
    inherit Attribute

Public Class XmlNamespaceDeclarationsAttribute
Inherits Attribute

Herencia

Object

Attribute

XmlNamespaceDeclarationsAttribute

Atributos

AttributeUsageAttribute

Comentarios

El XmlNamespaceDeclarationsAttribute atributo solo se puede aplicar una vez en una clase a un campo o propiedad que devuelve un XmlSerializerNamespaces objeto .

XmlNamespaceDeclarationsAttribute permite almacenar los prefijos y los espacios de nombres asociados, que se usan en un documento XML. Por ejemplo, un uso común del atributo es almacenar datos XPath, tal como se define en el documento World Wide Web Consortium denominado XML Language (XPath) Versión 1.0. En resumen, un XPath es una cadena que contiene muchos prefijos de espacio de nombres y nombres locales, junto con alguna otra sintaxis.

El lenguaje XPath permite la asociación de un prefijo con una ruta de acceso y el uso del prefijo dentro del documento XML. Por ejemplo, el siguiente documento XML denominado "select" contiene un prefijo ("cal") asociado a un URI específico (http://www.cohowinery.com/calendar/). El elemento contiene un atributo denominado "path" que contiene XPath.

<select xmlns:cal ="http://www.cohowinery.com/calendar/" path="cal:appointments/@startTime" />  

El esquema para esto podría ser:

<element name="select">  
   <complexType>  
      <simpleContent>  
         <attribute name="path" />  
      </simpleContent>  
   </complexType>  
</element>  

XmlNamespaceDeclarationsAttributeSin , se pierde la asociación entre el prefijo y el espacio de nombres.

Para conservar la asociación entre el prefijo y el URI del espacio de nombres, agregue un miembro que devuelva un XmlSerializerNamespaces objeto y aplique el XmlNamespaceDeclarationsAttribute atributo al miembro, como se muestra en el código de C# y Visual Basic siguiente:

// C#  
public class Select {  
  [XmlAttribute] public string path;  
  [XmlNamespaceDeclarations] public XmlSerializerNamespaces xmlns;  
}  
' Visual Basic  
Public Class Select  
   <XmlAttribute> Public path As String  
   <XmlNamespaceDeclarations> Public xmlns As XmlSerializerNamespaces  
End Class  

Cuando se serializa, el esquema del documento XML generado contiene el elemento de definición de esquema XML (XSD) denominado appinfo. El elemento contiene aún más un elemento de metadatos denominado keepNamespaceDeclarations, establecido en el nombre del miembro que contiene las declaraciones de espacio de nombres. El siguiente fragmento XML muestra el esquema:

<xs:element name="select">  
   <xs:complexType>  
      <xs:annotation>   
         <xs:appinfo>  
          <keepNamespaceDeclarations>xmlns</keepNamespaceDeclarations>  
         </xs:appinfo>   
      </xs:annotation>   
      <xs:simpleContent>  
         <xs:attribute name="path" />  
      </xs:simpleContent>  
   </xs:complexType>  
</xs:element>  

En la deserialización, el xmlns campo contiene un XmlSerializerNamespaces objeto que contiene todas las definiciones de prefijo de espacio de nombres.

En la serialización, el usuario puede agregar pares de espacio de nombres de prefijo al XmlSerializerNamespaces objeto mediante el Add método . Esto se muestra en el código de C# y Visual Basic siguiente:

// C#  
using System;  
using System.IO;  
using System.Xml.Serialization;  
[XmlRoot("select")]  
public class Select {  
   [XmlAttribute]  
   public string xpath;  
   [XmlNamespaceDeclarations]  
   public XmlSerializerNamespaces xmlns;  
}  
public class Test {  
   public static void Main(string[] args) {  
      Select mySelect = new Select();  
      mySelect.xpath = "myNS:ref/@common:y";  
      mySelect.xmlns = new XmlSerializerNamespaces();  
      mySelect.xmlns.Add("MyNS", "myNS.tempuri.org");  
      mySelect.xmlns.Add("common", "common.tempuri.org");  
      XmlSerializer ser = new XmlSerializer(typeof(Select));  
      ser.Serialize(Console.Out, mySelect);  
   }  
}  
// Output:  
// <?xml version="1.0" encoding="IBM437"?>  
// <select xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"   
// xmlns:common="common.tempuri.org" xmlns:MyNS="myNS.tempuri.org" xpath="myNS:ref/@common:y" />  
' Visual Basic  
Imports System  
Imports System.IO  
Imports System.Xml.Serialization  
<XmlRoot("select")> _  
Public Class SelectPath  
   <XmlAttribute> _  
   Public xpath As String   
   <XmlNamespaceDeclarations> _  
   public xmlns As XmlSerializerNamespaces   
End Class  
Public Class Test   
   Public Shared Sub Main()   
      Dim mySelect As SelectPath = New SelectPath()  
      mySelect.xpath = "myNS:ref/@common:y"  
      mySelect.xmlns = New XmlSerializerNamespaces()  
      mySelect.xmlns.Add("MyNS", "myNS.tempuri.org")  
      mySelect.xmlns.Add("common", "common.tempuri.org")  
      Dim ser As XmlSerializer = New XmlSerializer(mySelect.GetType)  
      ser.Serialize(Console.Out, mySelect)  
   End Sub  
End Class  
'Output:  
' <?xml version="1.0" encoding="IBM437"?>  
' <select xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"   
' xmlns:common="common.tempuri.org" xmlns:MyNS="myNS.tempuri.org" xpath="myNS:ref/@common:y" />  

Tenga en cuenta también que el miembro al que se aplica el atributo contiene solo los pares de espacio de nombres de prefijo que pertenecen al elemento XML definido por la clase . Por ejemplo, en el siguiente documento XML, solo se captura el par de prefijos "cal", pero no el prefijo "x". Para obtener esos datos, agregue un miembro con a XmlNamespaceDeclarationsAttribute la clase que representa el root elemento .

<?xml version="1.0"?>  
<x:root xmlns:x="http://www.cohowinery.com/x/">  
  <x:select xmlns:cal="http://www.cohowinery.com/calendar/" path="cal:appointments/@cal:startTime" />  
</x:root>  

Constructores

Propiedades

Métodos

Implementaciones de interfaz explícitas

Se aplica a