XmlAttributeAttribute XmlAttributeAttribute XmlAttributeAttribute XmlAttributeAttribute Class

定義

XmlSerializer がクラス メンバーを XML 属性としてシリアル化する必要があることを指定します。Specifies that the XmlSerializer must serialize the class member as an XML attribute.

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

次の例では、が適用されるいくつかのXmlAttributeAttributeフィールドを含むクラスをシリアル化します。The following example serializes a class that contains several fields to which the XmlAttributeAttribute is applied.

#using <System.Xml.dll>
#using <System.dll>

using namespace System;
using namespace System::IO;
using namespace System::Xml;
using namespace System::Xml::Serialization;
using namespace System::Xml::Schema;

public ref class Group
{
public:

   [XmlAttributeAttribute(Namespace="http://www.cpandl.com")]
   String^ GroupName;

   [XmlAttributeAttribute(DataType="base64Binary")]
   array<Byte>^GroupNumber;

   [XmlAttributeAttribute(DataType="date",AttributeName="CreationDate")]
   DateTime Today;
};

void SerializeObject( String^ filename )
{
   // Create an instance of the XmlSerializer class.
   XmlSerializer^ mySerializer = gcnew XmlSerializer( Group::typeid );

   // Writing the file requires a TextWriter.
   TextWriter^ writer = gcnew StreamWriter( filename );

   // Create an instance of the class that will be serialized.
   Group^ myGroup = gcnew Group;

   // Set the object properties.
   myGroup->GroupName = ".NET";
   array<Byte>^hexByte = {Convert::ToByte( 100 ),Convert::ToByte( 50 )};
   myGroup->GroupNumber = hexByte;
   DateTime myDate = DateTime(2001,1,10);
   myGroup->Today = myDate;

   // Serialize the class, and close the TextWriter.
   mySerializer->Serialize( writer, myGroup );
   writer->Close();
}

int main()
{
   SerializeObject( "Attributes.xml" );
}
using System;
using System.IO;
using System.Xml;
using System.Xml.Serialization;
using System.Xml.Schema;

public class Group
{
   [XmlAttribute (Namespace = "http://www.cpandl.com")]
   public string GroupName;
   
   [XmlAttribute(DataType = "base64Binary")]
   public Byte [] GroupNumber;

   [XmlAttribute(DataType = "date", AttributeName = "CreationDate")]
   public DateTime Today;
}


 
public class Run
{
   public static void Main()
   {
      Run test = new Run();
      test.SerializeObject("Attributes.xml");
   }


   public void SerializeObject(string filename)
   {
      // Create an instance of the XmlSerializer class.
      XmlSerializer mySerializer =  
      new XmlSerializer(typeof(Group));

      // Writing the file requires a TextWriter.
      TextWriter writer = new StreamWriter(filename);

      // Create an instance of the class that will be serialized.
      Group myGroup = new Group();

      // Set the object properties.
      myGroup.GroupName = ".NET";

      Byte [] hexByte = new Byte[2]{Convert.ToByte(100),
      Convert.ToByte(50)};
      myGroup.GroupNumber = hexByte;

      DateTime myDate = new DateTime(2001,1,10);
      myGroup.Today = myDate;

      // Serialize the class, and close the TextWriter.
      mySerializer.Serialize(writer, myGroup);
       writer.Close();
   }
}
   
Option Explicit
Option Strict

Imports System.IO
Imports System.Xml
Imports System.Xml.Serialization
Imports System.Xml.Schema


Public Class Group
    <XmlAttribute(Namespace := "http://www.cpandl.com")> _
        Public GroupName As String    
    <XmlAttribute(DataType := "base64Binary")> _
        Public GroupNumber() As Byte    
    <XmlAttribute(DataType := "date", AttributeName := "CreationDate")> _
        Public Today As DateTime
End Class

Public Class Run
    
    Public Shared Sub Main()
        Dim test As New Run()
        test.SerializeObject("Attributes.xml")
    End Sub 
    
    Public Sub SerializeObject(ByVal filename As String)
        ' Create an instance of the XmlSerializer class.
        Dim mySerializer As New XmlSerializer(GetType(Group))
        
        ' Writing the file requires a TextWriter.
        Dim writer As New StreamWriter(filename)
        
        ' Create an instance of the class that will be serialized.
        Dim myGroup As New Group()
        
        ' Set the object properties.
        myGroup.GroupName = ".NET"
        
        Dim hexByte() As Byte = {Convert.ToByte(100), Convert.ToByte(50)}
        myGroup.GroupNumber = hexByte
        
        Dim myDate As New DateTime(2001, 1, 10)
        myGroup.Today = myDate
        
        ' Serialize the class, and close the TextWriter.
        mySerializer.Serialize(writer, myGroup)
        writer.Close()
    End Sub
End Class

注釈

XmlAttributeAttribute 、がXmlSerializerオブジェクトをシリアル化 (逆シリアル化) する方法を制御する属性のファミリに属しています。The XmlAttributeAttribute belongs to a family of attributes that controls how the XmlSerializer serializes, or deserializes, an object. 類似する属性の完全な一覧については、「 XML シリアル化を制御する属性」を参照してください。For a complete list of similar attributes, see Attributes That Control XML Serialization.

パブリックフィールドまたはパブリックプロパティXmlAttributeAttributeに適用されると、は、 XmlSerializerメンバーを XML 属性としてシリアル化するようにに通知します。When applied to a public field or property, the XmlAttributeAttribute informs the XmlSerializer to serialize the member as an XML attribute. 既定では、 XmlSerializerは、パブリックフィールドとパブリックプロパティを XML 要素としてシリアル化します。By default, the XmlSerializer serializes public fields and properties as XML elements.

は、 XmlAttributeAttribute XML スキーマ定義言語 (xsd) の単純型 (xsd からanySimpleType派生したすべての組み込みデータ型を含む)にマップできる値(または値の配列)を返すパブリックフィールドまたはパブリックプロパティにのみ割り当てることができます。「」と入力します)。You can assign the XmlAttributeAttribute only to public fields or public properties that return a value (or array of values) that can be mapped to one of the XML Schema definition language (XSD) simple types (including all built-in datatypes derived from the XSD anySimpleType type). 使用できる型には、、 Guid Char、およびの各列挙体を含む、XSD の単純型にマップできるものがあります。The possible types include any that can be mapped to the XSD simple types, including Guid, Char, and enumerations. XSD 型DataTypeの一覧と、それらが to.NET データ型にマップされる方法については、プロパティを参照してください。See the DataType property for a list of XSD types and how they are mapped to.NET data types.

XmlAttributeAttribute 設定できるxml:space特殊な属性として、 (言語を指定)と(空白の処理方法を指定する)属性の2つがあります。xml:langThere are two special attributes that can be set with the XmlAttributeAttribute : the xml:lang (specifies language) and xml:space (specifies how to handle white space) attributes. これらの属性は、XML を処理するアプリケーションにのみ関連する情報を伝達することを目的としています。These attributes are intended to convey information that is relevant only to an application processing the XML. これらの設定の例を次のコードに示します。Examples of setting these are shown in the following code.

[XmlAttribute("xml:lang")]  
 public string Lang;  
 // Set this to 'default' or 'preserve'.  
 [XmlAttribute("space",   
 Namespace = "http://www.w3.org/XML/1998/namespace")]  
 public string Space 
<XmlAttribute("xml:lang")> _  
Public Lang As String   
' Set this to 'default' or 'preserve'.  
<XmlAttribute("space", _  
Namespace:= "http://www.w3.org/XML/1998/namespace")> _  
Public Space As String  

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

注意

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

コンストラクター

XmlAttributeAttribute() XmlAttributeAttribute() XmlAttributeAttribute() XmlAttributeAttribute()

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

XmlAttributeAttribute(String) XmlAttributeAttribute(String) XmlAttributeAttribute(String) XmlAttributeAttribute(String)

XmlAttributeAttribute クラスの新しいインスタンスを初期化し、生成される XML 属性の名前を指定します。Initializes a new instance of the XmlAttributeAttribute class and specifies the name of the generated XML attribute.

XmlAttributeAttribute(String, Type) XmlAttributeAttribute(String, Type) XmlAttributeAttribute(String, Type) XmlAttributeAttribute(String, Type)

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

XmlAttributeAttribute(Type) XmlAttributeAttribute(Type) XmlAttributeAttribute(Type) XmlAttributeAttribute(Type)

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

プロパティ

AttributeName AttributeName AttributeName AttributeName

XML 属性の名前を取得または設定します。Gets or sets the name of the XML attribute.

DataType DataType DataType DataType

XmlSerializer によって生成された XML 属性の XSD データ型を取得または設定します。Gets or sets the XSD data type of the XML attribute generated by the XmlSerializer.

Form Form Form Form

XmlSerializer によって生成された XML 属性名が修飾されているかどうかを示す値を取得または設定します。Gets or sets a value that indicates whether the XML attribute name generated by the XmlSerializer is qualified.

Namespace Namespace Namespace Namespace

XML 属性の XML 名前空間を取得または設定します。Gets or sets the XML namespace of the XML attribute.

Type Type Type Type

XML 属性の複合型を取得または設定します。Gets or sets the complex type of the XML attribute.

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)

適用対象