XmlNamespaceDeclarationsAttribute Classe

Definição

Namespace:

System.Xml.Serialization

Assembly:

System.Xml.ReaderWriter.dll

Origem:

XmlNamespaceDeclarationsAttribute.cs

Especifica que a propriedade de destino, parâmetro, o valor retornado ou o membro da classe contém prefixos associados a namespaces que são usados em um documento XML.

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, AllowMultiple=false)>]
type XmlNamespaceDeclarationsAttribute = class
    inherit Attribute

Public Class XmlNamespaceDeclarationsAttribute
Inherits Attribute

Herança

Object

Attribute

XmlNamespaceDeclarationsAttribute

Atributos

AttributeUsageAttribute

Comentários

O XmlNamespaceDeclarationsAttribute atributo só pode ser aplicado uma vez em uma classe a um campo ou propriedade que retorna um XmlSerializerNamespaces objeto .

O XmlNamespaceDeclarationsAttribute permite armazenar os prefixos e os namespaces associados, usados em um documento XML. Por exemplo, um uso comum do atributo é armazenar dados XPath, pois eles são definidos pelo documento world wide web consortium chamado XML Language (XPath) versão 1.0. Resumindo, um XPath é uma cadeia de caracteres que contém muitos prefixos de namespace e nomes locais, juntamente com alguma outra sintaxe.

A linguagem XPath permite a associação de um prefixo com um caminho e o uso do prefixo dentro do documento XML. Por exemplo, o documento XML a seguir chamado "select" contém um prefixo ("cal") associado a um URI específico (http://www.cohowinery.com/calendar/). O elemento contém um atributo chamado "path" que contém o XPath.

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

O esquema para isso pode ser:

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

Sem o XmlNamespaceDeclarationsAttribute, a associação entre o prefixo e o namespace é perdida.

Para manter a associação entre o prefixo e o URI do namespace, adicione um membro que retorna um XmlSerializerNamespaces objeto e aplique o XmlNamespaceDeclarationsAttribute atributo ao membro, conforme mostrado no código C# e Visual Basic a seguir:

// 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  

Quando serializado, o esquema do documento XML gerado contém o elemento XSD (definição de esquema XML) chamado appinfo. O elemento contém ainda um elemento de metadados chamado keepNamespaceDeclarations, definido como o nome do membro que contém as declarações de namespace. O seguinte fragmento XML mostra o 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>  

Na desserialização, o xmlns campo contém um XmlSerializerNamespaces objeto que contém todas as definições de prefixo de namespace.

Na serialização, o usuário pode adicionar pares prefix-namespace ao XmlSerializerNamespaces objeto usando o Add método . Isso é mostrado no seguinte código C# e Visual Basic:

// 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" />  

Observe também que o membro ao qual o atributo é aplicado contém apenas os pares prefix-namespace que pertencem ao elemento XML definido pela classe . Por exemplo, no documento XML a seguir, somente o par de prefixos "cal" é capturado, mas não o prefixo "x". Para obter esses dados, adicione um membro com o XmlNamespaceDeclarationsAttribute à classe que representa o 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>  

Construtores

XmlNamespaceDeclarationsAttribute()

Inicializa uma nova instância da classe XmlNamespaceDeclarationsAttribute.

Propriedades

TypeId

Quando implementado em uma classe derivada, obtém um identificador exclusivo para este Attribute. (Herdado de Attribute)

Métodos

Equals(Object)	Retorna um valor que indica se essa instância é igual a um objeto especificado. (Herdado de Attribute)
GetHashCode()	Retorna o código hash para a instância. (Herdado de Attribute)
GetType()	Obtém o Type da instância atual. (Herdado de Object)
IsDefaultAttribute()	Quando substituído em uma classe derivada, indica se o valor dessa instância é o valor padrão para a classe derivada. (Herdado de Attribute)
Match(Object)	Quando substituído em uma classe derivada, retorna um valor que indica se essa instância é igual a um objeto especificado. (Herdado de Attribute)
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object)