XmlNamespaceDeclarationsAttribute Classe

Definição

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

Herança

Object

Attribute

XmlNamespaceDeclarationsAttribute

Atributos

AttributeUsageAttribute

Observações

O XmlNamespaceDeclarationsAttribute atributo só pode ser aplicado uma vez numa classe a um corpo ou propriedade que devolve um XmlSerializerNamespaces objeto.

Permite XmlNamespaceDeclarationsAttribute armazenar os prefixos e os namespaces associados usados num documento XML. Por exemplo, uma utilização comum do atributo é armazenar dados XPath, tal como é definido pelo documento do World Wide Web Consortium denominado XML Language (XPath) Versão 1.0. Em resumo, um XPath é uma cadeia 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 a um caminho, e a utilização do prefixo dentro do documento XML. Por exemplo, o seguinte documento XML 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 isto 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 perde-se.

Para manter a associação entre o prefixo e o espaço de nomes URI, adicione um membro que devolve um objeto XmlSerializerNamespaces e aplique o atributo XmlNamespaceDeclarationsAttribute ao membro, como mostrado no seguinte código C# e Visual Basic:

// 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 para o documento XML gerado contém o elemento de definição XML Schema (XSD) chamado appinfo. O elemento contém ainda um elemento de metadados chamado keepNamespaceDeclarations, definido pelo nome do membro que contém as declarações do espaço de nomes. 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 prefixos do namespace.

Na serialização, o utilizador pode adicionar pares prefixo-espaço de nomes ao XmlSerializerNamespaces objeto usando o Add método. Isto é 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" />

Note-se também que o membro ao qual o atributo é aplicado contém apenas os pares prefixo-espaço de nomes que pertencem ao elemento XML definido pela classe. Por exemplo, no documento XML seguinte, apenas 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>