XmlIgnoreAttribute 클래스

정의

Serialize(TextWriter, Object)XmlSerializer 메서드를 호출하여 공용 필드 또는 공용 읽기/쓰기 속성 값을 serialize하지 않도록 합니다.Instructs the Serialize(TextWriter, Object) method of the XmlSerializer not to serialize the public field or public read/write property value.

public ref class XmlIgnoreAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.Property | System.AttributeTargets.ReturnValue)]
public class XmlIgnoreAttribute : Attribute
type XmlIgnoreAttribute = class
    inherit Attribute
Public Class XmlIgnoreAttribute
Inherits Attribute
상속
XmlIgnoreAttribute
특성

예제

다음 예제에서는 Comment라는 필드를 포함 하는 Group라는 클래스를 보여 줍니다.The following example shows a class named Group, which contains a field named Comment. 이 예제에서는 XmlIgnoreAttribute를 필드에 할당 하 여 클래스의 인스턴스를 serialize 하거나 deserialize 할 때 XmlSerializer 필드를 무시 하도록 지시 합니다.The example assigns the XmlIgnoreAttribute to the field, thereby instructing the XmlSerializer to ignore the field when serializing or deserializing an instance of the class.

public ref class Group
{
public:

   // The XmlSerializer ignores this field.

   [XmlIgnore]
   String^ Comment;

   // The XmlSerializer serializes this field.
   String^ GroupName;
};

public class Group
{
   // The XmlSerializer ignores this field.
   [XmlIgnore]
   public string Comment;

   // The XmlSerializer serializes this field.
   public string GroupName;
}
   
Public Class Group
    ' the XmlSerializer ignores this field.
    <XmlIgnore()> Public Comment As String
    
    ' The XmlSerializer serializes this field.
    Public GroupName As String
End Class

설명

XmlIgnoreAttributeXmlSerializer에서 개체를 serialize 하거나 deserialize 하는 방법을 제어 하는 특성 패밀리에 속합니다.The XmlIgnoreAttribute belongs to a family of attributes that controls how the XmlSerializer serializes or deserializes an object. XmlIgnoreAttribute를 클래스의 멤버에 적용 하는 경우 XmlSerializer는 클래스의 인스턴스를 serialize 하거나 deserialize 할 때 멤버를 무시 합니다.If you apply the XmlIgnoreAttribute to any member of a class, the XmlSerializer ignores the member when serializing or deserializing an instance of the class. 비슷한 특성의 전체 목록은 XML Serialization을 제어 하는 특성을 참조 하세요.For a complete list of similar attributes, see Attributes That Control XML Serialization.

XmlAttributes 개체를 만들고 해당 XmlIgnore 속성을 false로 설정 하 여 XmlIgnoreAttribute에 의해 발생 하는 동작을 재정의할 수 있습니다.You can override the behavior caused by the XmlIgnoreAttribute by creating an XmlAttributes object, and setting its XmlIgnore property to false. XmlAttributes 개체를 XmlAttributeOverrides 클래스의 인스턴스에 Add 해야 합니다.You must Add the XmlAttributes object to an instance of the XmlAttributeOverrides class. 마지막으로, Serialize 또는 Deserialize 메서드를 호출 하기 전에 XmlAttributeOverrides 개체를 사용 하 여 XmlSerializer 클래스의 인스턴스를 생성 해야 합니다.Lastly, you must use the XmlAttributeOverrides object to construct an instance of the XmlSerializer class before you call the Serialize or Deserialize methods.

XML 스키마 정의 도구 (xsd.exe) 는 때때로 스키마 파일 (.xsd)에서 클래스를 만들 때 XmlIgnoreAttribute을 생성 합니다.The XML Schema Definition Tool (Xsd.exe) occasionally generates the XmlIgnoreAttribute when creating classes from a schema file (.xsd). 이 동작은 값 형식을 null로 설정할 수 없지만 모든 XML 데이터 형식이 일 수 있기 때문에 발생 합니다.This behavior occurs because value types cannot be set to null, but all XML data types can be. 따라서이 도구는 값 형식에 매핑되는 XML 형식을 발견할 경우 두 개의 필드를 만듭니다. 하나는 값을 보유 하 고 fieldname, 다른 하나는 fieldnameSpecified형식으로 사용 되는 다른 특수 필드는 필드 또는 속성의 이름으로 바뀝니다.Therefore, the tool creates two fields when it encounters an XML type that maps to a value type: one to hold the value and another special field that takes the form of fieldnameSpecified, where the fieldname is replaced by the name of the field or property. 알 수 있는데, 스키마 요소에 없는 최소 발생을 지정 하는 경우에이 특수 필드 생성 되도록 (minOccurs = "0") 및 요소에 기본값은 없습니다.Notice, however, that this special field is generated only when the schema specifies that the element has no minimum occurrence (minOccurs = "0") and that the element has no default value. XmlSerializer는이 특수 필드를 설정 하 고 확인 하 여 필드 또는 속성에 값이 설정 되어 있는지 여부를 확인 합니다.The XmlSerializer sets and checks this special field to determine whether a value has been set for the field or property. 특수 필드가 serialize 되지 않아야 하기 때문에 도구에서 XmlIgnoreAttribute를 적용 합니다.Because the special field must not be serialized, the tool applies the XmlIgnoreAttribute to it.

특성을 사용 하는 방법에 대 한 자세한 내용은 참조 하세요. 특성합니다.For more information about using attributes, see Attributes.

참고

더 긴 XmlIgnoreAttribute대신 코드에서 XmlIgnore 단어를 사용할 수 있습니다.You can use the word XmlIgnore in your code instead of the longer XmlIgnoreAttribute.

생성자

XmlIgnoreAttribute()

XmlIgnoreAttribute 클래스의 새 인스턴스를 초기화합니다.Initializes a new instance of the XmlIgnoreAttribute class.

속성

TypeId

파생 클래스에서 구현될 때 이 Attribute의 고유 식별자를 가져옵니다.When implemented in a derived class, gets a unique identifier for this Attribute.

(다음에서 상속됨 Attribute)

메서드

Equals(Object)

이 인스턴스가 지정된 개체와 같은지를 나타내는 값을 반환합니다.Returns a value that indicates whether this instance is equal to a specified object.

(다음에서 상속됨 Attribute)
GetHashCode()

이 인스턴스의 해시 코드를 반환합니다.Returns the hash code for this instance.

(다음에서 상속됨 Attribute)
GetType()

현재 인스턴스의 Type을 가져옵니다.Gets the Type of the current instance.

(다음에서 상속됨 Object)
IsDefaultAttribute()

파생 클래스에서 재정의된 경우 이 인스턴스 값이 파생 클래스에 대한 기본값인지 여부를 표시합니다.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(다음에서 상속됨 Attribute)
Match(Object)

파생된 클래스에서 재정의할 경우,이 인스턴스가 지정된 된 개체와 같은지 여부를 나타내는 값을 반환 합니다.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(다음에서 상속됨 Attribute)
MemberwiseClone()

현재 Object의 단순 복사본을 만듭니다.Creates a shallow copy of the current Object.

(다음에서 상속됨 Object)
ToString()

현재 개체를 나타내는 string을 반환합니다.Returns a string that represents the current object.

(다음에서 상속됨 Object)

명시적 인터페이스 구현

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

이름 집합을 해당하는 디스패치 식별자 집합에 매핑합니다.Maps a set of names to a corresponding set of dispatch identifiers.

(다음에서 상속됨 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.

(다음에서 상속됨 Attribute)
_Attribute.GetTypeInfoCount(UInt32)

개체에서 제공하는 형식 정보 인터페이스의 수를 검색합니다(0 또는 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(다음에서 상속됨 Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

개체에서 노출하는 메서드와 속성에 대한 액세스를 제공합니다.Provides access to properties and methods exposed by an object.

(다음에서 상속됨 Attribute)

적용 대상

추가 정보