XmlRootAttribute.ElementName プロパティ

.NET Framework クラス ライブラリ リファレンス

XmlRootAttribute.ElementName プロパティ

XmlSerializer クラスの Serialize メソッドおよび Deserialize メソッドによって生成および認識される XML 要素名を取得または設定します。

名前空間: System.Xml.Serialization
アセンブリ: System.Xml (system.xml.dll 内)
構文

Visual Basic (宣言)

Public Property ElementName As
 String

Visual Basic (使用法)

Dim instance As XmlRootAttribute
Dim value As String

value = instance.ElementName

instance.ElementName = value

C#

public string ElementName { get;
 set; }

C++

public:
property String^ ElementName {
    String^ get ();
    void set (String^ value);
}

J#

/** @property */
public String get_ElementName ()

/** @property */
public void set_ElementName (String value)

JScript

public function get ElementName
 () : String

public function set ElementName
 (value : String)

プロパティ値
XML ドキュメント インスタンスで生成および認識された XML ルート要素名。既定値は、シリアル化されたクラスの名前です。

解説

生成された XML 要素の名前をクラス名とは異なる名前にする場合は、ElementName を指定します。

使用例

XmlRootAttribute クラスのインスタンスを作成し、ElementName プロパティに新しい値を設定する例を次に示します。次に、このオブジェクトを使用して、オブジェクトのシリアル化をオーバーライドするために使用される XmlAttributeOverrides オブジェクトを作成します。

Visual Basic

Public Sub SerializeOrder(filename As
 String)
   ' Create an XmlSerializer instance using the method below.
   Dim myXmlSerializer As XmlSerializer = CreateOverrider()

   ' Create the object, and set its Name property.
   Dim myStudent As New
 Student()
   myStudent.Name = "Student class1"

   ' Serialize the class, and close the TextWriter.
   Dim writer = New StreamWriter(filename)
   myXmlSerializer.Serialize(writer, myStudent)
   writer.Close()
End Sub

' Return an XmlSerializer to override the root serialization.
Public Function CreateOverrider() As
 XmlSerializer
   ' Create an XmlAttributes to override the default root element.
   Dim myXmlAttributes As New
 XmlAttributes()

   ' Create an XmlRootAttribute and set its element name and namespace.
   Dim myXmlRootAttribute As New
 XmlRootAttribute()
   myXmlRootAttribute.ElementName = "OverriddenRootElementName"
   myXmlRootAttribute.Namespace = "http://www.microsoft.com"

   ' Set the XmlRoot property to the XmlRoot object.
   myXmlAttributes.XmlRoot = myXmlRootAttribute
   Dim myXmlAttributeOverrides As New
 XmlAttributeOverrides()

   ' Add the XmlAttributes object to the XmlAttributeOverrides object.
   myXmlAttributeOverrides.Add(GetType(Student), myXmlAttributes)

   ' Create the Serializer, and return it.
   Dim myXmlSerializer As New
 XmlSerializer(GetType(Student), myXmlAttributeOverrides)
   Return myXmlSerializer
End Function

C#

public void SerializeOrder(string
 filename)
{
   // Create an XmlSerializer instance using the method below.
   XmlSerializer myXmlSerializer = CreateOverrider();

   // Create the object, and set its Name property.
   Student myStudent = new Student();
   myStudent.Name = "Student class1";

   // Serialize the class, and close the TextWriter.
   TextWriter writer = new StreamWriter(filename);
   myXmlSerializer.Serialize(writer, myStudent);
   writer.Close();
}

// Return an XmlSerializer to override the root serialization.
public XmlSerializer CreateOverrider()
{
   // Create an XmlAttributes to override the default root element.
   XmlAttributes myXmlAttributes = new XmlAttributes();

   // Create an XmlRootAttribute and set its element name and namespace.
   XmlRootAttribute myXmlRootAttribute = new XmlRootAttribute();
   myXmlRootAttribute.ElementName = "OverriddenRootElementName";
   myXmlRootAttribute.Namespace = "http://www.microsoft.com";

   // Set the XmlRoot property to the XmlRoot object.
   myXmlAttributes.XmlRoot = myXmlRootAttribute;
   XmlAttributeOverrides myXmlAttributeOverrides = 
                                 new XmlAttributeOverrides();
   
   /* Add the XmlAttributes object to the 
   XmlAttributeOverrides object. */
   myXmlAttributeOverrides.Add(typeof(Student), myXmlAttributes);

   // Create the Serializer, and return it.
   XmlSerializer myXmlSerializer = new XmlSerializer
      (typeof(Student), myXmlAttributeOverrides);
   return myXmlSerializer;
}

C++

public:
   void SerializeOrder( String^ filename )
   {
      // Create an XmlSerializer instance using the method below.
      XmlSerializer^ myXmlSerializer = CreateOverrider();
      
      // Create the object, and set its Name property.
      Student^ myStudent = gcnew Student;
      myStudent->Name = "Student class1";
      
      // Serialize the class, and close the TextWriter.
      TextWriter^ writer = gcnew StreamWriter( filename );
      myXmlSerializer->Serialize( writer, myStudent );
      writer->Close();
   }

   // Return an XmlSerializer to  the root serialization.
   XmlSerializer^ CreateOverrider()
   {
      // Create an XmlAttributes to  the default root element.
      XmlAttributes^ myXmlAttributes = gcnew XmlAttributes;
      
      // Create an XmlRootAttribute and set its element name and namespace.
      XmlRootAttribute^ myXmlRootAttribute = gcnew XmlRootAttribute;
      myXmlRootAttribute->ElementName = "OverriddenRootElementName";
      myXmlRootAttribute->Namespace = "http://www.microsoft.com";
      
      // Set the XmlRoot property to the XmlRoot object.
      myXmlAttributes->XmlRoot = myXmlRootAttribute;
      XmlAttributeOverrides^ myXmlAttributeOverrides =
         gcnew XmlAttributeOverrides;
      
      // Add the XmlAttributes object to the XmlAttributeOverrides object.
      myXmlAttributeOverrides->Add( Student::typeid, myXmlAttributes );
      
      // Create the Serializer, and return it.
      XmlSerializer^ myXmlSerializer = gcnew XmlSerializer(
         Student::typeid, myXmlAttributeOverrides );
      return myXmlSerializer;
   }

J#

public void SerializeOrder(String fileName)
{
    // Create an XmlSerializer instance using the method below.
    XmlSerializer myXmlSerializer = CreateOverrider();
    // Create the object, and set its name property.
    Student myStudent = new Student();
    myStudent.name = "Student class1";
    // Serialize the class, and close the TextWriter.
    TextWriter writer = new StreamWriter(fileName);
    myXmlSerializer.Serialize(writer, myStudent);
    writer.Close();
} //SerializeOrder

// Return an XmlSerializer to override the root serialization.
public XmlSerializer CreateOverrider()
{
    // Create an XmlAttributes to override the default root element.
    XmlAttributes myXmlAttributes = new XmlAttributes();
    // Create an XmlRootAttribute and set its element name and namespace.
    XmlRootAttribute myXmlRootAttribute = new XmlRootAttribute();
    myXmlRootAttribute.set_ElementName("OverriddenRootElementName");
    myXmlRootAttribute.set_Namespace("http://www.microsoft.com");
    // Set the XmlRoot property to the XmlRoot object.
    myXmlAttributes.set_XmlRoot(myXmlRootAttribute);
    XmlAttributeOverrides myXmlAttributeOverrides =
        new XmlAttributeOverrides();

    /* Add the XmlAttributes object to the 
       XmlAttributeOverrides object. 
     */
    myXmlAttributeOverrides.Add(Student.class.ToType(), myXmlAttributes);
    // Create the Serializer, and return it.
    XmlSerializer myXmlSerializer = new XmlSerializer(
        Student.class.ToType(), myXmlAttributeOverrides);
    return myXmlSerializer;
} //CreateOverrider

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
XmlRootAttribute クラス
XmlRootAttribute メンバ
System.Xml.Serialization 名前空間