XmlNamespaceDeclarationsAttribute Klas

Definitie

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

Overname

Object

Attribute

XmlNamespaceDeclarationsAttribute

Kenmerken

AttributeUsageAttribute

Opmerkingen

Het XmlNamespaceDeclarationsAttribute kenmerk kan slechts eenmaal in een klasse worden toegepast op een veld of eigenschap die een XmlSerializerNamespaces object retourneert.

Hiermee XmlNamespaceDeclarationsAttribute kunt u de voorvoegsels en de bijbehorende naamruimten opslaan die worden gebruikt in een XML-document. Een veelvoorkomend gebruik van het kenmerk is bijvoorbeeld het opslaan van XPath-gegevens, omdat dit wordt gedefinieerd door het World Wide Web Consortium-document met de naam XML Language (XPath) versie 1.0. Kortom, een XPath is een tekenreeks die veel naamruimtevoorvoegsels en lokale namen bevat, samen met een andere syntaxis.

Met de XPath-taal kunt u een voorvoegsel koppelen aan een pad en het voorvoegsel in het XML-document gebruiken. Het volgende XML-document met de naam 'select' bevat bijvoorbeeld een voorvoegsel (cal) dat is gekoppeld aan een specifieke URI (http://www.cohowinery.com/calendar/). Het element bevat een kenmerk met de naam 'pad' dat het XPath bevat.

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

Het schema hiervoor kan het volgende zijn:

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

Zonder de XmlNamespaceDeclarationsAttributenaamruimte gaat de koppeling tussen het voorvoegsel en de naamruimte verloren.

Als u de koppeling tussen het voorvoegsel en de naamruimte-URI wilt behouden, voegt u een lid toe dat een XmlSerializerNamespaces-object retourneert en past u het kenmerk XmlNamespaceDeclarationsAttribute toe op het lid, zoals wordt weergegeven in de volgende C# en Visual Basic code:

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

Wanneer het schema voor het gegenereerde XML-document wordt geserialiseerd, bevat het XSD-element appinfo(XML Schema Definition). Het element bevat verder een metagegevenselement met de naam keepNamespaceDeclarations, ingesteld op de naam van het lid dat de naamruimtedeclaraties bevat. Het volgende XML-fragment toont het 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>

Bij deserialisatie bevat het xmlns veld een XmlSerializerNamespaces object dat alle definities van naamruimtevoorvoegsels bevat.

Bij serialisatie kan de gebruiker met behulp van de Add methode voorvoegsel-naamruimteparen aan het XmlSerializerNamespaces object toevoegen. Dit wordt weergegeven in de volgende C# en Visual Basic code:

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

Houd er ook rekening mee dat het lid waarop het kenmerk wordt toegepast, alleen de voorvoegselnaamruimteparen bevat die deel uitmaken van het XML-element dat is gedefinieerd door de klasse. In het volgende XML-document wordt bijvoorbeeld alleen het voorvoegselpaar cal vastgelegd, maar niet het voorvoegsel 'x'. Als u deze gegevens wilt ophalen, voegt u een lid toe aan de XmlNamespaceDeclarationsAttribute klasse die het root element vertegenwoordigt.

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