ScriptIgnoreAttribute Classe

Définition

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

Héritage

Object

Attribute

ScriptIgnoreAttribute

Attributs

AttributeUsageAttribute

Exemples

L’exemple suivant montre comment s’appliquer ScriptIgnoreAttribute au Comment champ dans la classe personnalisée nommée Group. Cela indique JavaScriptSerializer d’ignorer le champ lors de la sérialisation d’une instance de la classe au format 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

Remarques

Si vous appliquez ScriptIgnoreAttribute à une propriété publique ou à un champ public d’une classe, JavaScriptSerializer ignore ou ignore, le membre lors de la sérialisation d’une instance de la classe au format JSON (JavaScript Object Notation).

La ScriptIgnoreAttribute propriété n’aura aucun effet si la ResponseFormat propriété est définie sur Xml. Si vous souhaitez avoir le même comportement lors de la sérialisation au format XML, XmlIgnoreAttribute vous devez l’appliquer à la propriété ou au champ à la place. Cela est dû au fait que la classe sera sérialisée à l’aide XmlSerializer de JavaScriptSerializer.

Vous pouvez également appliquer à la fois ScriptIgnoreAttribute et XmlIgnoreAttribute à une propriété ou à un champ. Dans ce cas, la propriété ou le champ est ignoré pour les formats de réponse JSON et XML.

Pour plus d’informations sur l’utilisation des attributs, consultez Attributs.