XmlAnyElementAttribute XmlAnyElementAttribute XmlAnyElementAttribute XmlAnyElementAttribute Class

定義

メンバー (XmlElement オブジェクトまたは XmlNode オブジェクトの配列を返すフィールド) に、シリアル化または逆シリアル化対象のオブジェクト内に対応するメンバーがない任意の XML 要素を表すオブジェクトを含めるように指定します。Specifies that the member (a field that returns an array of XmlElement or XmlNode objects) contains objects that represent any XML element that has no corresponding member in the object being serialized or deserialized.

public ref class XmlAnyElementAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.Property | System.AttributeTargets.ReturnValue, AllowMultiple=true)]
public class XmlAnyElementAttribute : Attribute
type XmlAnyElementAttribute = class
    inherit Attribute
Public Class XmlAnyElementAttribute
Inherits Attribute
継承
XmlAnyElementAttributeXmlAnyElementAttributeXmlAnyElementAttributeXmlAnyElementAttribute
属性

次の例ではXmlAnyElementAttribute 、オブジェクトのXmlElement配列AllElementsを返すという名前のフィールドにを適用します。The following example applies the XmlAnyElementAttribute to a field named AllElements that returns an array of XmlElement objects.

public ref class XClass
{
public:

   /* Apply the XmlAnyElementAttribute to a field returning an array
      of XmlElement objects. */

   [XmlAnyElement]
   array<XmlElement^>^AllElements;
};

public ref class Test
{
public:
   void DeserializeObject( String^ filename )
   {
      // Create an XmlSerializer.
      XmlSerializer^ mySerializer = gcnew XmlSerializer( XClass::typeid );

      // To read a file, a FileStream is needed.
      FileStream^ fs = gcnew FileStream( filename,FileMode::Open );

      // Deserialize the class.
      XClass^ x = dynamic_cast<XClass^>(mySerializer->Deserialize( fs ));

      // Read the element names and values.
      System::Collections::IEnumerator^ myEnum = x->AllElements->GetEnumerator();
      while ( myEnum->MoveNext() )
      {
         XmlElement^ xel = safe_cast<XmlElement^>(myEnum->Current);
         Console::WriteLine( "{0}: {1}", xel->LocalName, xel->Value );
      }
   }
};

int main()
{
   Test^ t = gcnew Test;
   t->DeserializeObject( "XFile.xml" );
}
public class XClass
{
   /* Apply the XmlAnyElementAttribute to a field returning an array
   of XmlElement objects. */
   [XmlAnyElement]
   public XmlElement[] AllElements;
}

public class Test
{
   public static void Main()
   {
      Test t = new Test();
      t.DeserializeObject("XFile.xml");
   }

   private void DeserializeObject(string filename)
   {
      // Create an XmlSerializer.
      XmlSerializer mySerializer = new XmlSerializer(typeof(XClass));

      // To read a file, a FileStream is needed.
      FileStream fs = new FileStream(filename, FileMode.Open);

      // Deserialize the class.
      XClass x = (XClass) mySerializer.Deserialize(fs);

      // Read the element names and values.
      foreach(XmlElement xel in x.AllElements)
         Console.WriteLine(xel.LocalName + ": " + xel.Value);
   }
}
Public Class XClass
    ' Apply the XmlAnyElementAttribute to a field returning an array
    ' of XmlElement objects.
    <XmlAnyElement()> Public AllElements() As XmlElement
End Class 'XClass


Public Class Test
    
    Public Shared Sub Main()
        Dim t As New Test()
        t.DeserializeObject("XFile.xml")
    End Sub
    
    
    Private Sub DeserializeObject(filename As String)
        ' Create an XmlSerializer.
        Dim mySerializer As New XmlSerializer(GetType(XClass))
        
        ' To read a file, a FileStream is needed.
        Dim fs As New FileStream(filename, FileMode.Open)
        
        ' Deserialize the class.
        Dim x As XClass = CType(mySerializer.Deserialize(fs), XClass)
        
        ' Read the element names and values.
        Dim xel As XmlElement
        For Each xel In  x.AllElements
            Console.WriteLine((xel.LocalName & ": " & xel.Value))
        Next xel
    End Sub
End Class 'Test 

注釈

ヒント

Silverlight、Windows Phone または Windows ストアアプリプロジェクトなどのポータブルクラスライブラリで作業していて、.NET Framework 4.0.3 以降を使用している場合はXElementXNodeXmlNodeXmlElement代わりにまたはを使用します。When working in a portable class library, such as in Silverlight, Windows Phone or Windows Store App project, and you are using the .NET Framework 4.0.3 and above, use XElement or XNode in place of XmlElement and XmlNode.

ドキュメントのXmlAnyElementAttribute一部として送信されるメタデータなど、xml ドキュメントの一部として送信できる任意のデータ (xml 要素) を格納するには、を使用します。Use the XmlAnyElementAttribute to contain arbitrary data (as XML elements) that can be sent as part of an XML document, such as metadata sent as part of the document.

オブジェクトまたはXmlElement XmlAnyElementAttribute オブジェクトの配列を返すフィールドにをXmlNode適用します。Apply the XmlAnyElementAttribute to a field that returns an array of XmlElement or XmlNode objects. このようなフィールドは、オブジェクトがシリアル化または逆シリアル化されているかどうかによって、2つの方法で使用できます。Such a field can be used in two ways, depending on whether an object is being serialized or deserialized. シリアル化する場合、オブジェクトは、シリアル化されているオブジェクトに対応するメンバー (またはメンバー) を持たない場合でも、XML 要素または XML ノードとして生成されます。When serialized, the object is generated as XML elements or nodes, even though they have no corresponding member (or members) in the object being serialized. 属性を適用するNameときにプロパティ値を指定するとXmlElementXmlNode配列に挿入されたすべてのオブジェクトまたはオブジェクトの要素名と既定の名前空間が同じである必要があります。それ以外の場合は、例外がスローされます。If you specify a Name property value when applying the attribute, all XmlElement or XmlNode objects inserted into the array must have the same element name and default namespace, or an exception is thrown. Namespaceプロパティ値を設定する場合は、 Nameプロパティも設定する必要があります。 XmlElementまたXmlNode 、またはオブジェクトの名前と名前空間の値も同じである必要があります。If you set the Namespace property value, you must set the Name property as well, and the XmlElement or XmlNode objects must also have the same name and namespace values. 値が指定されてXmlElementいないXmlNode場合は、オブジェクトまたはオブジェクトが任意の要素名を持つことができます。 NameIf no Name value is specified, the XmlElement or XmlNode objects can have any element name.

クラスのメソッドDeserializeを呼び出すと、逆シリアル化されるオブジェクト内の対応するメンバーを持たないすべての要素が配列に収集されます。 XmlSerializerWhen you call the Deserialize method of the XmlSerializer class, all elements that do not have a corresponding member in the object being deserialized are collected in the array. 逆シリアル化後に、項目のXmlElementコレクションを反復処理してデータを処理します。After deserialization, iterate through the collection of XmlElement items to process the data. Name値を指定した場合、配列にはその名前を持つ XML 要素だけが格納されます。If you specify a Name value, the array contains only XML elements with that name. Name値を指定しない場合、配列には、クラスに対応するメンバーを持たないすべての要素が含まれます。If you do not specify a Name value, the array contains all elements that have no corresponding member in the class. クラスに属性が適用される複数のフィールドが含まれている場合はName、、 NameNamespaceまたはの各プロパティを使用して、配列の内容を区別します。If a class contains more than one field to which the attribute is applied, use the Name, or Name and Namespace properties to differentiate between the contents of the arrays. このようなクラス (複数のフィールドを含む) にも、逆シリアル化の間にプロパティ値 ( NameNamespace) を区別しない1つのフィールドが含まれている場合、この配列にはまだ含まれていない不明な XML 要素が含まれます。その他の配列。If such a class (with multiple fields) also contains one field that has no differentiating property values set (in other words, Name and Namespace) during deserialization, this array contains any unknown XML elements that are not already contained in the other arrays. 1つのクラスに複数のフィールドが含まれていてName、それらNameNamespaceフィールドの区別、および値が設定されていない場合、逆シリアル化時の動作は指定されません。If a class contains more than one field that does not have a differentiating Name, or Name and Namespace value set, the behavior during deserialization is unspecified.

また、 XmlAnyElementAttributeを1つXmlElementのオブジェクトを返すフィールドに適用することもできます。You can also apply the XmlAnyElementAttribute to a field that returns a single XmlElement object. その場合は、 XmlElementクラスのプロパティとメソッドを使用して、不明な要素を再帰的に反復処理する必要があります。If you do so, you must use the properties and methods of the XmlElement class to recursively iterate through the unknown elements.

の複数のXmlAnyElementAttributeインスタンスをクラスメンバーに適用できますが、各インスタンスには個別Nameのプロパティ値が必要です。You can apply multiple instances of the XmlAnyElementAttribute to a class member, but each instance must have a distinct Name property value. または、インスタンスごとNameに同じプロパティが設定されているNamespace場合は、インスタンスごとに個別のプロパティ値を設定する必要があります。Or, if the same Name property is set for each instance, a distinct Namespace property value must be set for each instance.

クラスのUnknownAttributeメンバーにXmlAnyElementAttributeXmlSerializer適用すると、のイベントとイベントは発生しません。UnknownNodeThe UnknownNode and UnknownAttribute events of the XmlSerializer do not occur if you apply the XmlAnyElementAttribute to a member of a class.

注意

XmlAnyElement 長いXmlAnyElementAttributeのではなく、コードで単語を使用できます。You can use the word XmlAnyElement in your code instead of the longer XmlAnyElementAttribute.

属性の使用方法の詳細については、「属性」を参照してください。For more information about using attributes, see Attributes.

コンストラクター

XmlAnyElementAttribute() XmlAnyElementAttribute() XmlAnyElementAttribute() XmlAnyElementAttribute()

XmlAnyElementAttribute クラスの新しいインスタンスを初期化します。Initializes a new instance of the XmlAnyElementAttribute class.

XmlAnyElementAttribute(String) XmlAnyElementAttribute(String) XmlAnyElementAttribute(String) XmlAnyElementAttribute(String)

XmlAnyElementAttribute クラスの新しいインスタンスを初期化し、XML ドキュメントに生成される XML 要素名を指定します。Initializes a new instance of the XmlAnyElementAttribute class and specifies the XML element name generated in the XML document.

XmlAnyElementAttribute(String, String) XmlAnyElementAttribute(String, String) XmlAnyElementAttribute(String, String) XmlAnyElementAttribute(String, String)

XmlAnyElementAttribute クラスの新しいインスタンスを初期化し、XML ドキュメントに生成される XML 要素名とその XML 名前空間を指定します。Initializes a new instance of the XmlAnyElementAttribute class and specifies the XML element name generated in the XML document and its XML namespace.

プロパティ

Name Name Name Name

XML 要素名を取得または設定します。Gets or sets the XML element name.

Namespace Namespace Namespace Namespace

XML ドキュメントに生成される XML 名前空間を取得または設定します。Gets or sets the XML namespace generated in the XML document.

Order Order Order Order

要素のシリアル化または逆シリアル化を行う明示的な順序を取得または設定します。Gets or sets the explicit order in which the elements are serialized or deserialized.

TypeId TypeId TypeId TypeId

派生クラスで実装されると、この Attribute の一意の識別子を取得します。When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

メソッド

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

このインスタンスが、指定されたオブジェクトと等価であるかどうかを示す値を返します。Returns a value that indicates whether this instance is equal to a specified object.

(Inherited from Attribute)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

このインスタンスのハッシュ コードを返します。Returns the hash code for this instance.

(Inherited from Attribute)
GetType() GetType() GetType() GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute() 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) Match(Object) Match(Object) Match(Object)

派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

現在のオブジェクトを表す文字列を返します。Returns a string that represents the current object.

(Inherited from Object)

明示的なインターフェイスの実装

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _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) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _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) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _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) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

オブジェクトによって公開されたプロパティおよびメソッドへのアクセスを提供します。Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

適用対象

こちらもご覧ください