XmlArrayAttribute 클래스

정의

네임스페이스:

System.Xml.Serialization

어셈블리:

netstandard.dll, System.Xml.XmlSerializer.dll

Source:

XmlArrayAttribute.cs

XmlSerializer 특정 클래스 멤버를 XML 요소의 배열로 serialize하도록 지정합니다.

public ref class XmlArrayAttribute : Attribute

[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.Property | System.AttributeTargets.ReturnValue, AllowMultiple=false)]
public class XmlArrayAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.Property | System.AttributeTargets.ReturnValue, AllowMultiple=false)>]
type XmlArrayAttribute = class
    inherit Attribute

Public Class XmlArrayAttribute
Inherits Attribute

상속

Object

Attribute

XmlArrayAttribute

특성

AttributeUsageAttribute

예제

다음 예제에서는 여러 개체 배열을 포함하는 XML 문서로 클래스 인스턴스를 직렬화합니다. XML XmlArrayAttribute 요소 배열이 되는 멤버에 적용됩니다.

using System;
using System.IO;
using System.Xml.Serialization;
using System.Xml;

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

   public void SerializeDocument(string filename)
   {
      // Creates a new XmlSerializer.
      XmlSerializer s =
      new XmlSerializer(typeof(MyRootClass));

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

      // Creates an instance of the class to serialize.
      MyRootClass myRootClass = new MyRootClass();

      /* Uses a basic method of creating an XML array: Create and
      populate a string array, and assign it to the
      MyStringArray property. */

      string [] myString = {"Hello", "world", "!"};
      myRootClass.MyStringArray = myString;

      /* Uses a more advanced method of creating an array:
         create instances of the Item and BookItem, where BookItem
         is derived from Item. */
      Item item1 = new Item();
      BookItem item2 = new BookItem();

      // Sets the objects' properties.
      item1.ItemName = "Widget1";
      item1.ItemCode = "w1";
      item1.ItemPrice = 231;
      item1.ItemQuantity = 3;

      item2.ItemCode = "w2";
      item2.ItemPrice = 123;
      item2.ItemQuantity = 7;
      item2.ISBN = "34982333";
      item2.Title = "Book of Widgets";
      item2.Author = "John Smith";

      // Fills the array with the items.
      Item [] myItems = {item1,item2};

      // Sets the class's Items property to the array.
      myRootClass.Items = myItems;

      /* Serializes the class, writes it to disk, and closes
         the TextWriter. */
      s.Serialize(myWriter, myRootClass);
      myWriter.Close();
   }
}

// This is the class that will be serialized.
public class MyRootClass
{
   private Item [] items;

   /* Here is a simple way to serialize the array as XML. Using the
      XmlArrayAttribute, assign an element name and namespace. The
      IsNullable property determines whether the element will be
      generated if the field is set to a null value. If set to true,
      the default, setting it to a null value will cause the XML
      xsi:null attribute to be generated. */
   [XmlArray(ElementName = "MyStrings",
   Namespace = "http://www.cpandl.com", IsNullable = true)]
   public string[] MyStringArray;

   /* Here is a more complex example of applying an
      XmlArrayAttribute. The Items property can contain both Item
      and BookItem objects. Use the XmlArrayItemAttribute to specify
      that both types can be inserted into the array. */
   [XmlArrayItem(ElementName= "Item",
   IsNullable=true,
   Type = typeof(Item),
   Namespace = "http://www.cpandl.com"),
   XmlArrayItem(ElementName = "BookItem",
   IsNullable = true,
   Type = typeof(BookItem),
   Namespace = "http://www.cohowinery.com")]
   [XmlArray]
   public Item []Items
   {
      get{return items;}
      set{items = value;}
   }
}

public class Item{
   [XmlElement(ElementName = "OrderItem")]
   public string ItemName;
   public string ItemCode;
   public decimal ItemPrice;
   public int ItemQuantity;
}

public class BookItem:Item
{
   public string Title;
   public string Author;
   public string ISBN;
}

Option Explicit
Option Strict

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


Public Class Run
    
    Public Shared Sub Main()
        Dim test As New Run()
        test.SerializeDocument("books.xml")
    End Sub
    
    
    Public Sub SerializeDocument(ByVal filename As String)
        ' Creates a new XmlSerializer.
        Dim s As New XmlSerializer(GetType(MyRootClass))
        
        ' Writing the file requires a StreamWriter.
        Dim myWriter As New StreamWriter(filename)
        
        ' Creates an instance of the class to serialize. 
        Dim myRootClass As New MyRootClass()
        
        ' Uses a basic method of creating an XML array: Create and
        ' populate a string array, and assign it to the
        ' MyStringArray property. 
        
        Dim myString() As String =  {"Hello", "world", "!"}
        myRootClass.MyStringArray = myString
        
        ' Uses a more advanced method of creating an array:
        ' create instances of the Item and BookItem, where BookItem
        ' is derived from Item. 
        Dim item1 As New Item()
        Dim item2 As New BookItem()
        
        ' Sets the objects' properties.
        With item1
            .ItemName = "Widget1"
            .ItemCode = "w1"
            .ItemPrice = 231
            .ItemQuantity = 3
        End With

        With item2
            .ItemCode = "w2"
            .ItemPrice = 123
            .ItemQuantity = 7
            .ISBN = "34982333"
            .Title = "Book of Widgets"
            .Author = "John Smith"
        End With
        
        ' Fills the array with the items.
        Dim myItems() As Item =  {item1, item2}
        
        ' Set class's Items property to the array.
        myRootClass.Items = myItems
        
        ' Serializes the class, writes it to disk, and closes
        ' the TextWriter. 
        s.Serialize(myWriter, myRootClass)
        myWriter.Close()
    End Sub
End Class


' This is the class that will be serialized.
Public Class MyRootClass
    Private myItems() As Item
    
    ' Here is a simple way to serialize the array as XML. Using the
    ' XmlArrayAttribute, assign an element name and namespace. The
    ' IsNullable property determines whether the element will be
    ' generated if the field is set to a null value. If set to true,
    ' the default, setting it to a null value will cause the XML
    ' xsi:null attribute to be generated.
    <XmlArray(ElementName := "MyStrings", _
         Namespace := "http://www.cpandl.com", _
         IsNullable := True)> _
    Public MyStringArray() As String
    
    ' Here is a more complex example of applying an
    ' XmlArrayAttribute. The Items property can contain both Item
    ' and BookItem objects. Use the XmlArrayItemAttribute to specify
    ' that both types can be inserted into the array.
    <XmlArrayItem(ElementName := "Item", _
        IsNullable := True, _
        Type := GetType(Item), _
        Namespace := "http://www.cpandl.com"), _
     XmlArrayItem(ElementName := "BookItem", _
        IsNullable := True, _
        Type := GetType(BookItem), _
        Namespace := "http://www.cohowinery.com"), _
     XmlArray()> _
    Public Property Items As Item()
        Get
            Return myItems
        End Get
        Set
            myItems = value
        End Set
    End Property
End Class
 
Public Class Item
    <XmlElement(ElementName := "OrderItem")> _
    Public ItemName As String
    Public ItemCode As String
    Public ItemPrice As Decimal
    Public ItemQuantity As Integer
End Class

Public Class BookItem
    Inherits Item
    Public Title As String
    Public Author As String
    Public ISBN As String
End Class

설명

개체 XmlArrayAttribute 를 직렬화하거나 역직렬화하는 방법을 XmlSerializer 제어하는 특성 패밀리에 속합니다. 유사한 특성의 전체 목록은 XML Serialization을 제어하는 특성을 참조하세요.

개체 배열을 XmlArrayAttribute 반환하는 공용 필드 또는 읽기/쓰기 속성에 적용할 수 있습니다. 인터페이스를 구현하는 개체를 반환하는 필드나 반환 ArrayList 하는 컬렉션 및 필드에 적용할 수도 있습니다 IEnumerable .

클래스 멤버에 XmlArrayAttribute 적용할 때 클래스의 XmlSerializer 메서드는 해당 멤버 Serialize 에서 중첩된 XML 요소 시퀀스를 생성합니다. XML 스키마 문서(.xsd 파일)는 이러한 배열을 다음과 같이 complexType나타냅니다. 예를 들어 serialize할 클래스가 구매 주문을 나타내는 경우 주문 항목을 나타내는 개체 배열을 반환하는 공용 필드에 적용하여 XmlArrayAttribute 구매한 항목의 배열을 생성할 수 있습니다.

복합 또는 기본 형식 개체 XmlSerializer 의 배열을 반환하는 공용 필드 또는 속성에 특성이 적용되지 않으면 기본적으로 중첩된 XML 요소 시퀀스가 생성됩니다. 생성되는 XML 요소를 보다 정확하게 제어하려면 필드 또는 속성에 및 XmlArrayItemAttribute 해당 XmlArrayAttribute 요소를 적용합니다. 예를 들어 기본적으로 생성된 XML 요소의 이름은 멤버 식별자에서 파생됩니다. 속성을 설정 ElementName 하여 생성된 XML 요소의 이름을 변경할 수 있습니다.

특정 형식의 항목과 해당 형식에서 파생된 모든 클래스를 포함하는 배열을 serialize하는 경우 각 형식을 선언하는 데 사용해야 XmlArrayItemAttribute 합니다.

메모

더 긴 XmlArrayAttribute대신 코드에서 사용할 XmlArray 수 있습니다.

특성 사용에 대한 자세한 내용은 특성을 참조하세요.

생성자

Name	Description
XmlArrayAttribute()	XmlArrayAttribute 클래스의 새 인스턴스를 초기화합니다.
XmlArrayAttribute(String)	클래스의 새 인스턴스를 XmlArrayAttribute 초기화하고 XML 문서 인스턴스에서 생성된 XML 요소 이름을 지정합니다.

속성

Name	Description
ElementName	serialize된 배열에 지정된 XML 요소 이름을 가져오거나 설정합니다.
Form	XML 요소 이름에서 생성된 XmlSerializer 이름이 정규화되었는지 아니면 정규화되지 않았는지를 나타내는 값을 가져오거나 설정합니다.
IsNullable	특성true이 설정된 빈 XML 태그 xsi:nil 로 멤버를 serialize해야 하는지 여부를 XmlSerializer 나타내는 값을 가져오거나 설정합니다.
Namespace	XML 요소의 네임스페이스를 가져오거나 설정합니다.
Order	요소가 직렬화되거나 역직렬화되는 명시적 순서를 가져오거나 설정합니다.
TypeId	파생 클래스에서 구현되는 경우 이 Attribute대한 고유 식별자를 가져옵니다. (다음에서 상속됨 Attribute)

메서드

Name	Description
Equals(Object)	이 인스턴스가 지정된 개체와 같은지 여부를 나타내는 값을 반환합니다. (다음에서 상속됨 Attribute)
GetHashCode()	이 인스턴스의 해시 코드를 반환합니다. (다음에서 상속됨 Attribute)
GetType()	현재 인스턴스의 Type 가져옵니다. (다음에서 상속됨 Object)
IsDefaultAttribute()	파생 클래스에서 재정의되는 경우 이 인스턴스의 값이 파생 클래스의 기본값인지 여부를 나타냅니다. (다음에서 상속됨 Attribute)
Match(Object)	파생 클래스에서 재정의되는 경우 이 인스턴스가 지정된 개체와 같은지 여부를 나타내는 값을 반환합니다. (다음에서 상속됨 Attribute)
MemberwiseClone()	현재 Object단순 복사본을 만듭니다. (다음에서 상속됨 Object)
ToString()	현재 개체를 나타내는 문자열을 반환합니다. (다음에서 상속됨 Object)

추가 정보

• XmlArray
• XmlArrayItemAttribute
• XmlAttributeOverrides
• XmlAttributes
• XML Serialization 소개
• 방법: XML 스트림의 대체 요소 이름 지정
• 특성을 사용하여 XML Serialization 제어
• XML Serialization의 예
• XML 스키마 정의 도구(Xsd.exe)