XmlNamespaceDeclarationsAttribute Klasse

Definition

Gibt an, dass Zieleigenschaft, Zielparameter, Zielrückgabewert oder Zielklassenmember Präfixe enthalten, die den innerhalb eines XML-Dokuments verwendeten Namespaces zugeordnet werden.Specifies that the target property, parameter, return value, or class member contains prefixes associated with namespaces that are used within an XML document.

public ref class XmlNamespaceDeclarationsAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.Property | System.AttributeTargets.ReturnValue, AllowMultiple=false)]
[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.Property | System.AttributeTargets.ReturnValue)]
public class XmlNamespaceDeclarationsAttribute : Attribute
type XmlNamespaceDeclarationsAttribute = class
    inherit Attribute
Public Class XmlNamespaceDeclarationsAttribute
Inherits Attribute
Vererbung
XmlNamespaceDeclarationsAttribute
Attribute

Hinweise

Das XmlNamespaceDeclarationsAttribute Attribut kann nur einmal in einer Klasse auf ein Feld oder eine Eigenschaft angewendet werden, das XmlSerializerNamespaces ein Objekt zurückgibt.The XmlNamespaceDeclarationsAttribute attribute can only be applied once in a class to a field or property that returns an XmlSerializerNamespaces object.

XmlNamespaceDeclarationsAttribute Ermöglicht das Speichern der Präfixe und der zugeordneten Namespaces, die in einem XML-Dokument verwendet werden.The XmlNamespaceDeclarationsAttribute allows you to store the prefixes, and the associated namespaces, used in an XML document. Beispielsweise besteht eine häufige Verwendung des-Attributs darin, XPath-Daten zu speichern, da Sie durch das World Wide Web Consortium Dokument mit der Bezeichnung XML Language (XPath) Version 1,0definiert werden.For example, one common usage of the attribute is to store XPath data, as it is defined by the World Wide Web Consortium document named XML Language (XPath) Version 1.0. Ein XPath ist eine Zeichenfolge, die viele Namespace Präfixe und lokale Namen sowie eine andere Syntax enthält.In brief, an XPath is a string that contains many namespace prefixes and local names, along with some other syntax.

Die XPath-Sprache ermöglicht die Zuordnung eines Präfixes zu einem Pfad und das Verwenden des Präfixes innerhalb des XML-Dokuments.The XPath language allows for the association of a prefix with a path, and using the prefix within the XML document. Das folgende XML-Dokument mit dem Namen "Select" enthält z. b. ein Präfix ("CAL"),http://www.cohowinery.com/calendar/das einem bestimmten URI () zugeordnet ist.For example, the following XML document named "select" contains a prefix ("cal") associated with a specific URI (http://www.cohowinery.com/calendar/). Das-Element enthält ein Attribut mit dem Namen "Path", das den XPath enthält.The element contains an attribute named "path" that contains the XPath.

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

Das Schema hierfür könnte wie folgt lauten:The schema for this might be:

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

XmlNamespaceDeclarationsAttributeOhne ist die Zuordnung zwischen dem Präfix und dem Namespace verloren.Without the XmlNamespaceDeclarationsAttribute, the association between the prefix and the namespace is lost.

Fügen Sie ein Element hinzu, das ein XmlSerializerNamespaces -Objekt zurückgibt, und wenden Sie das XmlNamespaceDeclarationsAttribute -Attribut auf das-Element an, wie in der folgenden C# und Visual Basic Code gezeigt, um die Zuordnung zwischen dem Präfix und dem Namespace-URI beizubehalten:To retain the association between the prefix and the namespace URI, add a member that returns an XmlSerializerNamespaces object and apply the XmlNamespaceDeclarationsAttribute attribute to the member, as shown in the following C# and 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  

Bei der Serialisierung enthält das Schema für das generierte XML-Dokument das XSD-Element (XML Schema Definition appinfo) mit dem Namen.When serialized, the schema for the generated XML document contains the XML Schema definition (XSD) element named appinfo. Das-Element enthält weiter ein Metadatenelement keepNamespaceDeclarationsmit dem Namen, das auf den Namen des Members festgelegt ist, der die Namespace Deklarationen enthält.The element further contains a metadata element named keepNamespaceDeclarations, set to the name of the member that contains the namespace declarations. Das folgende XML-Fragment zeigt das Schema:The following XML fragment shows the 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>  

Bei der Deserialisierung enthält xmlns das Feld ein XmlSerializerNamespaces Objekt, das alle Namespace-Präfix Definitionen enthält.On deserialization, the xmlns field contains an XmlSerializerNamespaces object that contains all namespace prefix definitions.

Bei der Serialisierung kann der Benutzer dem- XmlSerializerNamespaces Objekt mit der Add -Methode Präfix-Namespace-Paare hinzufügen.On serialization, the user can add prefix-namespace pairs to the XmlSerializerNamespaces object using the Add method. Dies wird im folgenden C# und Visual Basic Code gezeigt:This is shown in the following C# and 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" />  

Beachten Sie auch, dass der Member, auf den das-Attribut angewendet wird, nur die Präfix-Namespace-Paare enthält, die zu dem von der-Klasse definierten XML-Element gehören.Also note that the member to which the attribute is applied contains only the prefix-namespace pairs that belong to the XML element defined by the class. Im folgenden XML-Dokument wird z. b. nur das Präfix paar "CAL" erfasst, aber nicht das Präfix "x".For example, in the following XML document, only the prefix pair "cal" is captured, but not the "x" prefix. Um diese Daten zu erhalten, fügen Sie der Klasse XmlNamespaceDeclarationsAttribute , die das root Element darstellt, ein Element mit dem-Element hinzu.To get that data, add a member with the XmlNamespaceDeclarationsAttribute to the class that represents the root element.

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

Konstruktoren

XmlNamespaceDeclarationsAttribute()

Initialisiert eine neue Instanz der XmlNamespaceDeclarationsAttribute-Klasse.Initializes a new instance of the XmlNamespaceDeclarationsAttribute class.

Eigenschaften

TypeId

Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab.When implemented in a derived class, gets a unique identifier for this Attribute.

(Geerbt von Attribute)

Methoden

Equals(Object)

Gibt einen Wert zurück, der angibt, ob diese Instanz gleich einem angegebenen Objekt ist.Returns a value that indicates whether this instance is equal to a specified object.

(Geerbt von Attribute)
GetHashCode()

Gibt den Hashcode für diese Instanz zurück.Returns the hash code for this instance.

(Geerbt von Attribute)
GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Geerbt von Object)
IsDefaultAttribute()

Gibt beim Überschreiben in einer abgeleiteten Klasse an, ob der Wert der Instanz der Standardwert für die abgeleitete Klasse ist.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Geerbt von Attribute)
Match(Object)

Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Geerbt von Attribute)
MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Geerbt von Object)
ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Geerbt von Object)

Explizite Schnittstellenimplementierungen

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Ordnet eine Reihe von Namen einer entsprechenden Reihe von Dispatchbezeichnern zu.Maps a set of names to a corresponding set of dispatch identifiers.

(Geerbt von Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Ruft die Typinformationen für ein Objekt ab, mit deren Hilfe die Typinformationen für eine Schnittstelle abgerufen werden können.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Geerbt von Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Ruft die Anzahl der Schnittstellen mit Typinformationen ab, die von einem Objekt bereitgestellt werden (0 oder 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Geerbt von Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Stellt den Zugriff auf von einem Objekt verfügbar gemachte Eigenschaften und Methoden bereit.Provides access to properties and methods exposed by an object.

(Geerbt von Attribute)

Gilt für: