ScriptIgnoreAttribute ScriptIgnoreAttribute ScriptIgnoreAttribute ScriptIgnoreAttribute Class

Definición

Especifica que JavaScriptSerializer no serializará la propiedad pública o el campo público.Specifies that JavaScriptSerializer will not serialize the public property or public field. Esta clase no puede heredarse.This class cannot be inherited.

public ref class ScriptIgnoreAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.Property | System.AttributeTargets.Field)]
[System.AttributeUsage(System.AttributeTargets.Property | System.AttributeTargets.Field, AllowMultiple=false, Inherited=true)]
public sealed class ScriptIgnoreAttribute : Attribute
type ScriptIgnoreAttribute = class
    inherit Attribute
Public NotInheritable Class ScriptIgnoreAttribute
Inherits Attribute
Herencia
ScriptIgnoreAttributeScriptIgnoreAttributeScriptIgnoreAttributeScriptIgnoreAttribute
Atributos

Ejemplos

En el ejemplo siguiente se muestra cómo aplicar ScriptIgnoreAttribute a la Comment campo en la clase personalizada denominada Group.The following example demonstrates how to apply ScriptIgnoreAttribute to the Comment field in the custom class named Group. Esto indica a JavaScriptSerializer para pasar por alto el campo al serializar una instancia de la clase en formato 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 Microsoft.VisualBasic
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

Comentarios

Si aplica ScriptIgnoreAttribute a una propiedad pública o campo público de una clase, a continuación, JavaScriptSerializer omite o se omite, el miembro al serializar una instancia de la clase al formato 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.

El ScriptIgnoreAttribute no tendrá ningún efecto si la ResponseFormat propiedad está establecida en Xml.The ScriptIgnoreAttribute will have no effect if the ResponseFormat property is set to Xml. Si desea tener el mismo comportamiento al serializar en formato XML, XmlIgnoreAttribute se debe aplicar a la propiedad o campo en su lugar.If you want to have the same behavior when serializing to XML format, XmlIgnoreAttribute should be applied to the property or field instead. Esto es porque la clase se serializará utilizando XmlSerializer en lugar de JavaScriptSerializer.This is because the class will be serialized by using XmlSerializer instead of JavaScriptSerializer.

También puede aplicar tanto ScriptIgnoreAttribute y XmlIgnoreAttribute a una propiedad o campo.You can also apply both ScriptIgnoreAttribute and XmlIgnoreAttribute to a property or field. En este caso, el campo o propiedad se omitirá para formatos de respuesta JSON y XML.In this case, the property or field will be ignored for JSON and XML response formats.

Para obtener más información acerca de cómo utilizar los atributos, vea atributos.For more information about how to use attributes, see Attributes.

Constructores

ScriptIgnoreAttribute() ScriptIgnoreAttribute() ScriptIgnoreAttribute() ScriptIgnoreAttribute()

Inicializa una nueva instancia de la clase ScriptIgnoreAttribute.Initializes a new instance of the ScriptIgnoreAttribute class.

Propiedades

ApplyToOverrides ApplyToOverrides ApplyToOverrides ApplyToOverrides

Obtiene o establece si reemplazar ScriptIgnoreAttribute de modo que JavaScriptSerializer considere la serialización de la propiedad o el campo público.Gets or set whether to override the ScriptIgnoreAttribute so that the JavaScriptSerializer will consider the serialization of the public property or public field.

TypeId TypeId TypeId TypeId

Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Métodos

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Devuelve un valor que indica si esta instancia es igual que un objeto especificado.Returns a value that indicates whether this instance is equal to a specified object.

(Inherited from Attribute)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Devuelve el código hash de esta instancia.Returns the hash code for this instance.

(Inherited from Attribute)
GetType() GetType() GetType() GetType()

Obtiene el Type de la instancia actual.Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute()

Si se reemplaza en una clase derivada, indica si el valor de esta instancia es el valor predeterminado de la clase derivada.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Inherited from Attribute)
Match(Object) Match(Object) Match(Object) Match(Object)

Cuando se invalida en una clase derivada, devuelve un valor que indica si esta instancia es igual a un objeto especificado.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Crea una copia superficial del objeto Object actual.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Devuelve una cadena que representa el objeto actual.Returns a string that represents the current object.

(Inherited from Object)

Implementaciones de interfaz explícitas

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Asigna un conjunto de nombres a un conjunto correspondiente de identificadores de envío.Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Obtiene la información de tipos de un objeto, que puede utilizarse para obtener la información de tipos de una interfaz.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32)

Recupera el número de interfaces de información de tipo que proporciona un objeto (0 ó 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Proporciona acceso a las propiedades y los métodos expuestos por un objeto.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Se aplica a