XmlNamespaceDeclarationsAttribute Classe

Definizione

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

Ereditarietà

Object

Attribute

XmlNamespaceDeclarationsAttribute

Attributi

AttributeUsageAttribute

Commenti

L'attributo XmlNamespaceDeclarationsAttribute può essere applicato una sola volta in una classe a un campo o a una proprietà che restituisce un XmlSerializerNamespaces oggetto .

XmlNamespaceDeclarationsAttribute consente di archiviare i prefissi e gli spazi dei nomi associati, usati in un documento XML. Ad esempio, un uso comune dell'attributo consiste nell'archiviare i dati XPath, come definito dal documento World Wide Web Consortium denominato XML Language (XPath) versione 1.0. In breve, un XPath è una stringa che contiene molti prefissi dello spazio dei nomi e nomi locali, insieme ad altre sintassi.

Il linguaggio XPath consente l'associazione di un prefisso con un percorso e l'uso del prefisso all'interno del documento XML. Ad esempio, il documento XML seguente denominato "select" contiene un prefisso ("cal") associato a un URI specifico (http://www.cohowinery.com/calendar/). L'elemento contiene un attributo denominato "path" che contiene L'oggetto XPath.

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

Lo schema per questo potrebbe essere:

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

XmlNamespaceDeclarationsAttributeSenza , l'associazione tra il prefisso e lo spazio dei nomi viene persa.

Per mantenere l'associazione tra il prefisso e l'URI dello spazio dei nomi, aggiungere un membro che restituisce un oggetto XmlSerializerNamespaces e applicare l'attributo XmlNamespaceDeclarationsAttribute al membro, come illustrato nel codice C# e Visual Basic seguente:

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

Se serializzato, lo schema per il documento XML generato contiene l'elemento XSD (XML Schema Definition) denominato appinfo. L'elemento contiene inoltre un elemento di metadati denominato keepNamespaceDeclarations, impostato sul nome del membro che contiene le dichiarazioni dello spazio dei nomi. Il frammento XML seguente mostra lo schema:

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

In caso di deserializzazione, il xmlns campo contiene un XmlSerializerNamespaces oggetto che contiene tutte le definizioni di prefisso dello spazio dei nomi.

Durante la serializzazione, l'utente può aggiungere coppie di prefix-namespace all'oggetto XmlSerializerNamespaces usando il Add metodo . Questo è illustrato nel codice C# e Visual Basic seguente:

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

Si noti inoltre che il membro a cui viene applicato l'attributo contiene solo le coppie prefix-namespace che appartengono all'elemento XML definito dalla classe . Nel documento XML seguente, ad esempio, viene acquisita solo la coppia di prefissi "cal", ma non il prefisso "x". Per ottenere tali dati, aggiungere un membro con XmlNamespaceDeclarationsAttribute alla classe che rappresenta l'elemento root .

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