XmlNamespaceDeclarationsAttribute 类

参考

定义

命名空间:: System.Xml.Serialization

程序集:: System.Xml.XmlSerializer.dll

程序集:: System.Xml.ReaderWriter.dll

程序集:: System.Xml.dll

程序集:: netstandard.dll

重要

一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。

指定目标属性、参数、返回值或类成员包含与 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)]
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

继承: Object

Attribute
XmlNamespaceDeclarationsAttribute

属性: AttributeUsageAttribute

注解

XmlNamespaceDeclarationsAttribute该属性只能在类中应用于返回XmlSerializerNamespaces对象的字段或属性一次。

这样 XmlNamespaceDeclarationsAttribute ，就可以存储 XML 文档中使用的前缀和关联的命名空间。例如，属性的一个常见用法是存储 XPath 数据，因为它由名为 XML 语言 (XPath) 版本 1.0 的万维网联盟文档定义。简言之，XPath 是一个字符串，其中包含许多命名空间前缀和本地名称，以及其他一些语法。

XPath 语言允许将前缀与路径关联，并使用 XML 文档中的前缀。例如，名为“select”的以下 XML 文档包含与特定 URI http://www.cohowinery.com/calendar/ 关联的前缀 (“cal”) () 。该元素包含一个名为“path”的属性，其中包含 XPath。

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

此架构可能是：

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

如果没有， XmlNamespaceDeclarationsAttribute前缀与命名空间之间的关联将丢失。

若要保留前缀与命名空间 URI 之间的关联，请添加返回对象并将属性应用于XmlNamespaceDeclarationsAttribute成员的成员XmlSerializerNamespaces，如以下 C# 和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

序列化时，生成的 XML 文档的架构包含名为 appinfoXSD) 元素的 XML 架构定义 (。该元素进一步包含一 keepNamespaceDeclarations个名为的元数据元素，设置为包含命名空间声明的成员的名称。以下 XML 片段显示了架构：

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

在反序列化时，字段 xmlns 包含包含 XmlSerializerNamespaces 所有命名空间前缀定义的对象。

在序列化时，用户可以使用该方法向对象Add添加前缀命名空间对XmlSerializerNamespaces。这显示在以下 C# 和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" />

另请注意，应用该属性的成员仅包含属于类定义的 XML 元素的前缀命名空间对。例如，在以下 XML 文档中，仅捕获前缀对“cal”，但未捕获“x”前缀。若要获取该数据，请向表示元素的root类添加一XmlNamespaceDeclarationsAttribute个成员。

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

构造函数

XmlNamespaceDeclarationsAttribute()

初始化 XmlNamespaceDeclarationsAttribute 类的新实例。

属性

TypeId

在派生类中实现时，获取此 Attribute 的唯一标识符。

(继承自 Attribute)

方法

Equals(Object)	返回一个值，该值指示此实例是否与指定的对象相等。 (继承自 Attribute)
GetHashCode()	返回此实例的哈希代码。 (继承自 Attribute)
GetType()	获取当前实例的 Type。 (继承自 Object)
IsDefaultAttribute()	在派生类中重写时，指示此实例的值是否是派生类的默认值。 (继承自 Attribute)
Match(Object)	当在派生类中重写时，返回一个指示此实例是否等于指定对象的值。 (继承自 Attribute)
MemberwiseClone()	创建当前 Object 的浅表副本。 (继承自 Object)
ToString()	返回表示当前对象的字符串。 (继承自 Object)

显式接口实现

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	将一组名称映射为对应的一组调度标识符。 (继承自 Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	检索对象的类型信息，然后可以使用该信息获取接口的类型信息。 (继承自 Attribute)
_Attribute.GetTypeInfoCount(UInt32)	检索对象提供的类型信息接口的数量（0 或 1）。 (继承自 Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	提供对某一对象公开的属性和方法的访问。 (继承自 Attribute)

适用于

通过

XmlNamespaceDeclarationsAttribute 类

定义

注解

构造函数

属性

方法

显式接口实现

适用于

其他资源