XmlIgnoreAttribute

.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

C#

[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

J#

/** @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

C#

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;
};

J#

public class Group
{
    // The XmlSerializer ignores this field.
    /** @attribute XmlIgnore()
     */
    public String comment;
    // The XmlSerializer serializes this field.
    public String groupName;
} //Group

継承階層

System.Object
   System.Attribute
    System.Xml.Serialization.XmlIgnoreAttribute

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

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

参照

関連項目
XmlIgnoreAttribute メンバ
System.Xml.Serialization 名前空間
XmlAttributeOverrides クラス
XmlAttributes クラス
XmlAttributes.XmlIgnore プロパティ
XmlSerializer
XmlAttributes クラス
その他の技術情報
XML シリアル化の概要
方法 : XML ストリームの代替要素名を指定する
属性を使用した XML シリアル化の制御
XML シリアル化の例
XML スキーマ定義ツール (Xsd.exe)

XmlIgnoreAttribute コンストラクタ

XmlIgnoreAttribute クラスの新しいインスタンスを初期化します。

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

Visual Basic (宣言)

Public Sub New

Visual Basic (使用法)

Dim instance As New XmlIgnoreAttribute

C#

public XmlIgnoreAttribute ()

C++

public:
XmlIgnoreAttribute ()

J#

public XmlIgnoreAttribute ()

JScript

public function XmlIgnoreAttribute ()

使用例

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

C#

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;
};

J#

public class Group
{
    // The XmlSerializer ignores this field.
    /** @attribute XmlIgnore()
     */
    public String comment;
    // The XmlSerializer serializes this field.
    public String groupName;
} //Group

プラットフォーム

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

参照

関連項目
XmlIgnoreAttribute クラス
XmlIgnoreAttribute メンバ
System.Xml.Serialization 名前空間
XmlAttributes.XmlIgnore プロパティ
XmlAttributeOverrides クラス
XmlSerializer

XmlIgnoreAttribute プロパティ

パブリック プロパティ

	名前	説明
	TypeId	派生クラスに実装されている場合は、この Attribute の一意の識別子を取得します。 ( Attribute から継承されます。)

参照

関連項目

XmlIgnoreAttribute クラス
System.Xml.Serialization 名前空間
XmlAttributeOverrides クラス
XmlAttributes クラス
XmlAttributes.XmlIgnore プロパティ
XmlSerializer
XmlAttributes クラス

その他の技術情報

XML シリアル化の概要
方法 : XML ストリームの代替要素名を指定する
属性を使用した XML シリアル化の制御
XML シリアル化の例
XML スキーマ定義ツール (Xsd.exe)

XmlIgnoreAttribute メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 ( Attribute から継承されます。)
	GetCustomAttribute	オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用された指定した型のカスタム属性を取得します。 ( Attribute から継承されます。)
	GetCustomAttributes	オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されたカスタム属性の配列を取得します。 ( Attribute から継承されます。)
	GetHashCode	このインスタンスのハッシュ コードを返します。 ( Attribute から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	IsDefaultAttribute	派生クラス内でオーバーライドされたときに、このインスタンスの値が派生クラスの既定値かどうかを示します。 ( Attribute から継承されます。)
	IsDefined	オーバーロードされます。 指定した型のカスタム属性が、アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されているかどうかを判断します。 ( Attribute から継承されます。)
	Match	派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。 ( Attribute から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

参照

関連項目

XmlIgnoreAttribute クラス
System.Xml.Serialization 名前空間
XmlAttributeOverrides クラス
XmlAttributes クラス
XmlAttributes.XmlIgnore プロパティ
XmlSerializer
XmlAttributes クラス

その他の技術情報

XML シリアル化の概要
方法 : XML ストリームの代替要素名を指定する
属性を使用した XML シリアル化の制御
XML シリアル化の例
XML スキーマ定義ツール (Xsd.exe)

XmlIgnoreAttribute メンバ

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

XmlIgnoreAttribute データ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ

	名前	説明
	XmlIgnoreAttribute	XmlIgnoreAttribute クラスの新しいインスタンスを初期化します。

パブリック プロパティ

	名前	説明
	TypeId	派生クラスに実装されている場合は、この Attribute の一意の識別子を取得します。(Attribute から継承されます。)

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 ( Attribute から継承されます。)
	GetCustomAttribute	オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用された指定した型のカスタム属性を取得します。 (Attribute から継承されます。)
	GetCustomAttributes	オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されたカスタム属性の配列を取得します。 (Attribute から継承されます。)
	GetHashCode	このインスタンスのハッシュ コードを返します。 (Attribute から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	IsDefaultAttribute	派生クラス内でオーバーライドされたときに、このインスタンスの値が派生クラスの既定値かどうかを示します。 (Attribute から継承されます。)
	IsDefined	オーバーロードされます。 指定した型のカスタム属性が、アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されているかどうかを判断します。 (Attribute から継承されます。)
	Match	派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。 (Attribute から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)

参照

関連項目

XmlIgnoreAttribute クラス
System.Xml.Serialization 名前空間
XmlAttributeOverrides クラス
XmlAttributes クラス
XmlAttributes.XmlIgnore プロパティ
XmlSerializer
XmlAttributes クラス

その他の技術情報

XML シリアル化の概要
方法 : XML ストリームの代替要素名を指定する
属性を使用した XML シリアル化の制御
XML シリアル化の例
XML スキーマ定義ツール (Xsd.exe)