XmlNamespaceDeclarationsAttribute 類別

定義

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 文件包含與特定 URIhttp://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 之間的關聯，請新增一個成員回傳 XmlSerializerNamespaces 物件，並將 XmlNamespaceDeclarationsAttribute 屬性套用於該成員，如下 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 文件結構包含名為 appinfo的 XML 結構定義（XSD）元素。 該元素還包含一個名為 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 一個物件，該物件包含所有命名空間前綴定義。

在序列化時，使用者可以使用此XmlSerializerNamespaces方法為物件添加前綴與命名空間對Add。 以下 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」前綴。 要取得該資料，請將一個帶有 的 XmlNamespaceDeclarationsAttribute 成員加入代表該 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>