XmlNamespaceDeclarationsAttribute Class

Definition

Указывает, что целевое свойство, параметр, возвращаемое значение или член класса содержат префиксы, связанные с пространствами имен, которые используются в XML-документе.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)]
public class XmlNamespaceDeclarationsAttribute : Attribute
[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
Inheritance
XmlNamespaceDeclarationsAttribute
Attributes

Remarks

Атрибут XmlNamespaceDeclarationsAttribute можно применить только один раз в классе к полю или свойству, которое возвращает объект XmlSerializerNamespaces.The XmlNamespaceDeclarationsAttribute attribute can only be applied once in a class to a field or property that returns an XmlSerializerNamespaces object.

XmlNamespaceDeclarationsAttribute позволяет хранить префиксы и связанные пространства имен, используемые в XML-документе.The XmlNamespaceDeclarationsAttribute allows you to store the prefixes, and the associated namespaces, used in an XML document. Например, одним из распространенных способов использования атрибута является хранение данных XPath, так как оно определяется консорциум W3C документом с именем язык XML (XPath) версии 1,0.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. Вкратце, XPath — это строка, которая содержит множество префиксов пространств имен и локальных имен, а также другой синтаксис.In brief, an XPath is a string that contains many namespace prefixes and local names, along with some other syntax.

Язык XPath позволяет связать префикс с путем и использовать префикс в XML-документе.The XPath language allows for the association of a prefix with a path, and using the prefix within the XML document. Например, следующий XML-документ с именем "Select" содержит префикс (CAL), связанный с конкретным URI (http://www.cohowinery.com/calendar/).For example, the following XML document named "select" contains a prefix ("cal") associated with a specific URI (http://www.cohowinery.com/calendar/). Элемент содержит атрибут с именем path, который содержит XPath.The element contains an attribute named "path" that contains the XPath.

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

Схема для этого может выглядеть следующим образом:The schema for this might be:

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

Без XmlNamespaceDeclarationsAttributeсвязь между префиксом и пространством имен теряется.Without the XmlNamespaceDeclarationsAttribute, the association between the prefix and the namespace is lost.

Чтобы сохранить связь между префиксом и URI пространства имен, добавьте элемент, возвращающий объект XmlSerializerNamespaces, и примените атрибут XmlNamespaceDeclarationsAttribute к элементу, как показано в следующем C# коде и Visual Basic кода: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  

При сериализации схема созданного XML-документа содержит элемент определения схемы XML (XSD) с именем appinfo.When serialized, the schema for the generated XML document contains the XML Schema definition (XSD) element named appinfo. Элемент далее содержит элемент метаданных с именем keepNamespaceDeclarationsи задает имя элемента, содержащего объявления пространств имен.The element further contains a metadata element named keepNamespaceDeclarations, set to the name of the member that contains the namespace declarations. Схема показана в следующем фрагменте кода XML: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>  

При десериализации поле xmlns содержит объект XmlSerializerNamespaces, содержащий все определения префиксов пространств имен.On deserialization, the xmlns field contains an XmlSerializerNamespaces object that contains all namespace prefix definitions.

При сериализации пользователь может добавить пары префикс-пространство имен в объект XmlSerializerNamespaces с помощью метода Add.On serialization, the user can add prefix-namespace pairs to the XmlSerializerNamespaces object using the Add method. Это показано в следующем C# и Visual Basic коде: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" />  

Также обратите внимание, что элемент, к которому применяется атрибут, содержит только пары префикс-пространство имен, принадлежащие элементу XML, определенному классом.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. Например, в следующем XML-документе записывается только пара префиксов "CAL", но не префикс "x".For example, in the following XML document, only the prefix pair "cal" is captured, but not the "x" prefix. Чтобы получить эти данные, добавьте элемент с XmlNamespaceDeclarationsAttribute в класс, представляющий элемент root.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>  

Constructors

XmlNamespaceDeclarationsAttribute()

Инициализирует новый экземпляр класса XmlNamespaceDeclarationsAttribute.Initializes a new instance of the XmlNamespaceDeclarationsAttribute class.

Properties

TypeId

В случае реализации в производном классе возвращает уникальный идентификатор для этого атрибута Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Methods

Equals(Object)

Возвращает значение, показывающее, равен ли экземпляр указанному объекту.Returns a value that indicates whether this instance is equal to a specified object.

(Inherited from Attribute)
GetHashCode()

Возвращает хэш-код для этого экземпляра.Returns the hash code for this instance.

(Inherited from Attribute)
GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute()

При переопределении в производном классе указывает, является ли значение этого экземпляра значением по умолчанию для производного класса.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Inherited from Attribute)
Match(Object)

При переопределении в производном классе возвращает значение, указывающее, является ли этот экземпляр равным заданному объекту.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Inherited from Object)

Explicit Interface Implementations

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

Сопоставляет набор имен соответствующему набору идентификаторов диспетчеризации.Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Возвращает сведения о типе объекта, которые можно использовать для получения сведений о типе интерфейса.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Возвращает количество предоставляемых объектом интерфейсов для доступа к сведениям о типе (0 или 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Предоставляет доступ к открытым свойствам и методам объекта.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Applies to