ScriptIgnoreAttribute クラス

定義

名前空間:

System.Web.Script.Serialization

アセンブリ:

System.Web.Extensions.dll

JavaScriptSerializer がパブリック プロパティまたはパブリック フィールドをシリアル化しないことを指定します。 このクラスは継承できません。

public ref class ScriptIgnoreAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=false, Inherited=true)]
public sealed class ScriptIgnoreAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=false, Inherited=true)>]
type ScriptIgnoreAttribute = class
    inherit Attribute

Public NotInheritable Class ScriptIgnoreAttribute
Inherits Attribute

継承

Object

Attribute

ScriptIgnoreAttribute

属性

AttributeUsageAttribute

例

次の例では、ScriptIgnoreAttribute という名前のカスタム クラスのComment フィールドにGroupを適用する方法を示します。 これは、クラスのインスタンスを JSON 形式にシリアル化するときに、フィールドを無視するように JavaScriptSerializer に指示します。

using System;
using System.Web.Script.Serialization;

public class Group
{
    // The JavaScriptSerializer ignores this field.
    [ScriptIgnore]
    public string Comment;

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

Imports System.Web.Script.Serialization

Public Class Group
    ' The JavaScriptSerializer ignores this field.
    <ScriptIgnore()> Public Comment As String

    ' The JavaScriptSerializer serializes this field.
    Public GroupName As String
End Class

注釈

クラスのパブリック プロパティまたはパブリック フィールドに ScriptIgnoreAttribute を適用した場合、クラスのインスタンスを JavaScript Object Notation (JSON) 形式にシリアル化するときに、メンバーは無視またはスキップ JavaScriptSerializer 。

ScriptIgnoreAttribute プロパティが ResponseFormat に設定されている場合、Xmlは無効になります。 XML 形式にシリアル化するときに同じ動作をする場合は、代わりにプロパティまたはフィールドに XmlIgnoreAttribute を適用する必要があります。 これは、クラスがXmlSerializerではなくJavaScriptSerializerを使用してシリアル化されるためです。

プロパティまたはフィールドに ScriptIgnoreAttribute と XmlIgnoreAttribute の両方を適用することもできます。 この場合、JSON および XML 応答形式の場合、プロパティまたはフィールドは無視されます。

属性の使用方法の詳細については、「 属性」を参照してください。

コンストラクター

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

プロパティ

名前	説明
ApplyToOverrides	ScriptIgnoreAttributeがパブリック プロパティまたはパブリック フィールドのシリアル化を考慮するように、JavaScriptSerializerをオーバーライドするかどうかを取得または設定します。
TypeId	派生クラスで実装されている場合は、この Attributeの一意の識別子を取得します。 (継承元 Attribute)

メソッド

名前	説明
Equals(Object)	このインスタンスが指定したオブジェクトと等しいかどうかを示す値を返します。 (継承元 Attribute)
GetHashCode()	このインスタンスのハッシュ コードを返します。 (継承元 Attribute)
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
IsDefaultAttribute()	派生クラスでオーバーライドされた場合、このインスタンスの値が派生クラスの既定値であるかどうかを示します。 (継承元 Attribute)
Match(Object)	派生クラスでオーバーライドされた場合、このインスタンスが指定したオブジェクトと等しいかどうかを示す値を返します。 (継承元 Attribute)
MemberwiseClone()	現在の Objectの簡易コピーを作成します。 (継承元 Object)
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)

明示的なインターフェイスの実装

名前	説明
_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	一連の名前を対応する一連のディスパッチ識別子に割り当てます。 (継承元 Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	インターフェイスの型情報を取得するために使用できるオブジェクトの型情報を取得します。 (継承元 Attribute)
_Attribute.GetTypeInfoCount(UInt32)	オブジェクトが提供する型情報インターフェイスの数 (0 または 1) を取得します。 (継承元 Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	オブジェクトによって公開されるプロパティとメソッドへのアクセスを提供します。 (継承元 Attribute)