ScriptIgnoreAttribute クラス

定義

JavaScriptSerializer がパブリック プロパティまたはパブリック フィールドをシリアル化しないことを指定します。Specifies that JavaScriptSerializer will not serialize the public property or public field. このクラスは継承できません。This class cannot be inherited.

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
継承
ScriptIgnoreAttribute
属性

次の例は、 ScriptIgnoreAttribute という名前のカスタムクラスのフィールドにを適用する方法を示して Comment Group います。The following example demonstrates how to apply ScriptIgnoreAttribute to the Comment field in the custom class named Group. これ JavaScriptSerializer により、クラスのインスタンスを JSON 形式にシリアル化するときに、フィールドを無視するように指示されます。This instructs JavaScriptSerializer to ignore the field when serializing an instance of the class to JSON format.

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) 形式にシリアル化するときに、メンバーを無視するかスキップします。If you apply ScriptIgnoreAttribute to a public property or public field of a class, then JavaScriptSerializer ignores, or skips, the member when serializing an instance of the class to JavaScript Object Notation (JSON) format.

ScriptIgnoreAttribute ResponseFormat プロパティがに設定されている場合、は効果がありません XmlThe ScriptIgnoreAttribute will have no effect if the ResponseFormat property is set to Xml. XML 形式へのシリアル化時に同じ動作を使用する場合は、 XmlIgnoreAttribute 代わりにプロパティまたはフィールドにを適用する必要があります。If you want to have the same behavior when serializing to XML format, XmlIgnoreAttribute should be applied to the property or field instead. これは、クラスがの代わりにを使用してシリアル化されるためです XmlSerializer JavaScriptSerializerThis is because the class will be serialized by using XmlSerializer instead of JavaScriptSerializer.

また、 ScriptIgnoreAttributeXmlIgnoreAttribute の両方をプロパティまたはフィールドに適用することもできます。You can also apply both ScriptIgnoreAttribute and XmlIgnoreAttribute to a property or field. この場合、JSON および XML 応答形式では、プロパティまたはフィールドは無視されます。In this case, the property or field will be ignored for JSON and XML response formats.

属性を使用する方法の詳細については、属性を参照してください。For more information about how to use attributes, see Attributes.

コンストラクター

ScriptIgnoreAttribute()

ScriptIgnoreAttribute クラスの新しいインスタンスを初期化します。Initializes a new instance of the ScriptIgnoreAttribute class.

プロパティ

ApplyToOverrides

ScriptIgnoreAttribute がパブリック プロパティまたはパブリック フィールドのシリアル化を検討するように JavaScriptSerializer をオーバーライドするかどうかを取得または設定します。Gets or set whether to override the ScriptIgnoreAttribute so that the JavaScriptSerializer will consider the serialization of the public property or public field.

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()

現在のオブジェクトを表す文字列を返します。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)

適用対象