ScriptIgnoreAttribute クラス

リファレンス

定義

名前空間:: System.Web.Script.Serialization

アセンブリ:: System.Web.Extensions.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

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

public ref class ScriptIgnoreAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property)]
public sealed class ScriptIgnoreAttribute : 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)>]
type ScriptIgnoreAttribute = class
    inherit 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

例

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

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 した JavaScriptSerializer 場合、そのクラスのインスタンスを JavaScript Object Notation (JSON) 形式にシリアル化するときにメンバーを無視またはスキップします。

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

プロパティまたはフィールドの両方 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)

適用対象

次の方法で共有