XmlIgnoreAttribute クラス

定義

Serialize(TextWriter, Object)XmlSerializer メソッドに対して、パブリック フィールドまたはパブリックな読み書き可能プロパティの値をシリアル化しないように指示します。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 を割り当てます。これにより、クラスのインスタンスをシリアル化または逆シリアル化するときに、フィールドを無視するように 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

注釈

XmlIgnoreAttribute は、XmlSerializer がオブジェクトをシリアル化または逆シリアル化する方法を制御する属性のファミリに属しています。The XmlIgnoreAttribute belongs to a family of attributes that controls how the XmlSerializer serializes or deserializes an object. XmlIgnoreAttribute をクラスのメンバーに適用すると、クラスのインスタンスをシリアル化または逆シリアル化するときに、XmlSerializer はそのメンバーを無視します。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 シリアル化を制御する属性」を参照してください。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.

スキーマファイル (.xsd) からクラスを作成するときに、 XML スキーマ定義ツール (xsd.exe)によって 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 型が検出されると、2つのフィールドが作成されます。1つは値を保持するためのフィールドで、もう1つは fieldnameSpecifiedの形式を取る特別なフィールドです。この場合、fieldname はフィールドまたはプロパティの名前で置き換えられます。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. 特別なフィールドはシリアル化できないため、このフィールドには 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)

適用対象

こちらもご覧ください