XmlIgnoreAttribute クラスとは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引ランキング

XmlIgnoreAttribute クラス

XmlSerializer の Serialize メソッドに対して、パブリックフィールドまたはパブリックな読み書き可能プロパティの値をシリアル化しないように指示します。

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

Visual Basic (宣言)

<AttributeUsageAttribute(AttributeTargets.Property Or AttributeTargets.Field
 Or AttributeTargets.Parameter Or AttributeTargets.ReturnValue)>
 _
Public Class XmlIgnoreAttribute
    Inherits Attribute

Visual Basic (使用法)

Dim instance As XmlIgnoreAttribute

[AttributeUsageAttribute(AttributeTargets.Property|AttributeTargets.Field|AttributeTargets.Parameter|AttributeTargets.ReturnValue)]
 
public class XmlIgnoreAttribute : Attribute

C++

[AttributeUsageAttribute(AttributeTargets::Property|AttributeTargets::Field|AttributeTargets::Parameter|AttributeTargets::ReturnValue)]
 
public ref class XmlIgnoreAttribute : public
 Attribute

/** @attribute AttributeUsageAttribute(AttributeTargets.Property|AttributeTargets.Field|AttributeTargets.Parameter|AttributeTargets.ReturnValue)
 */ 
public class XmlIgnoreAttribute extends Attribute

JScript

AttributeUsageAttribute(AttributeTargets.Property|AttributeTargets.Field|AttributeTargets.Parameter|AttributeTargets.ReturnValue)
 
public class XmlIgnoreAttribute extends
 Attribute

解説

XmlIgnoreAttribute は、XmlSerializer がオブジェクトをシリアル化または逆シリアル化する方法を制御する一連の属性の 1 つです。XmlIgnoreAttribute をクラスのメンバに適用すると、XmlSerializer は、そのクラスのインスタンスをシリアル化または逆シリアル化するときに、このメンバを無視します。類似する属性の完全な一覧については、「XML シリアル化を制御する属性」を参照してください。

XmlIgnoreAttribute を適用したことによって生じる動作をオーバーライドするには、XmlAttributes オブジェクトを作成し、XmlIgnore プロパティを false に設定します。Add メソッドを使用して、この XmlAttributes オブジェクトを XmlAttributeOverrides クラスのインスタンスに追加する必要があります。最後に、XmlAttributeOverrides オブジェクトを使用して XmlSerializer クラスのインスタンスを構築してから Serialize メソッドまたは Deserialize メソッドを呼び出します。

XML スキーマ定義ツール (Xsd.exe) は、スキーマファイル (.xsd) からクラスを作成するときに XmlIgnoreAttribute を生成することがあります。この動作は、値型は null 参照 (Visual Basic では Nothing) に設定できないのに対して、すべての XML データ型は null に設定できるために発生します。したがって、このツールは、値型に割り当てられる XML 型を見つけた場合は 2 つのフィールドを作成します。1 つは値を保持するフィールドで、もう 1 つは fieldnameSpecified という名前の特別なフィールドです。fieldname は、フィールドまたはプロパティの名前になります。ただし、この特別なフィールドが作成されるのは、その要素には最小出現回数がなく (minOccurs = "0")、また、既定値もないことがスキーマに指定されている場合のみです。XmlSerializer は、この特別フィールドの設定およびチェックを行い、そのフィールドまたはプロパティに値が設定されているかどうかを判断します。特別フィールドはシリアル化できないため、特別フィールドには XmlIgnoreAttribute が適用されます。

属性の使用方法については、「属性を使用したメタデータの拡張」を参照してください。

メモ
コードでは、XmlIgnoreAttribute の代わりに XmlIgnore という短い語を使用できます。

使用例

Comment という名前のフィールドを含む Group という名前のクラスの例を次に示します。この例では、XmlIgnoreAttribute をフィールドに割り当てることにより、このクラスのインスタンスをシリアル化または逆シリアル化するときに、そのフィールドを無視するように XmlSerializer に指示しています。

Visual Basic

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

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

   // The XmlSerializer serializes this field.
   public string GroupName;
}

C++

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.
    /** @attribute XmlIgnore()
     */
    public String comment;
    // The XmlSerializer serializes this field.
    public String groupName;
} //Group