ScriptIgnoreAttribute Classe

Definição

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

Herança

Object

Attribute

ScriptIgnoreAttribute

Atributos

AttributeUsageAttribute

Exemplos

O exemplo seguinte demonstra como aplicar ScriptIgnoreAttribute ao Comment campo na classe personalizada chamada Group. Isto instrui JavaScriptSerializer a ignorar o campo ao serializar uma instância da classe para formato 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

Observações

Se aplicar ScriptIgnoreAttribute a uma propriedade pública ou campo público de uma classe, ignora JavaScriptSerializer ou ignora o membro ao serializar uma instância da classe para o formato JavaScript Object Notation (JSON).

O ScriptIgnoreAttribute não terá efeito se a ResponseFormat propriedade for definida para Xml. Se quiser ter o mesmo comportamento ao serializar para formato XML, XmlIgnoreAttribute deve ser aplicado à propriedade ou campo em vez disso. Isto porque a classe será serializada usando XmlSerializer em vez de JavaScriptSerializer.

Também pode aplicar ambos ScriptIgnoreAttribute e XmlIgnoreAttribute a uma propriedade ou campo. Neste caso, a propriedade ou campo será ignorado para formatos de resposta JSON e XML.

Para mais informações sobre como usar os atributos, consulte Atributos.