ScriptIgnoreAttribute Klasse

Definition

Gibt an, dass JavaScriptSerializer die öffentliche Eigenschaft oder das öffentliches Feld nicht serialisiert.Specifies that JavaScriptSerializer will not serialize the public property or public field. Diese Klasse kann nicht vererbt werden.This class cannot be inherited.

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

Beispiele

Im folgenden Beispiel wird veranschaulicht, wie ScriptIgnoreAttribute Comment Sie das-Feld in der benutzerdefinierten GroupKlasse mit dem Namen anwenden können.The following example demonstrates how to apply ScriptIgnoreAttribute to the Comment field in the custom class named Group. Dies weist JavaScriptSerializer an, das Feld zu ignorieren, wenn eine Instanz der Klasse in das JSON-Format serialisiert wird.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

Hinweise

Wenn Sie auf ScriptIgnoreAttribute eine öffentliche Eigenschaft oder ein öffentliches Feld einer Klasse anwenden JavaScriptSerializer , wird das Element beim Serialisieren einer Instanz der Klasse in JavaScript Object Notation Format (JSON) ignoriert oder überladen.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.

Der ScriptIgnoreAttribute hat keine Auswirkung, wenn die ResponseFormat -Eigenschaft auf Xmlfestgelegt ist.The ScriptIgnoreAttribute will have no effect if the ResponseFormat property is set to Xml. Wenn Sie das gleiche Verhalten bei der Serialisierung in das XML-Format haben XmlIgnoreAttribute möchten, sollten Sie stattdessen auf die Eigenschaft oder das Feld angewendet werden.If you want to have the same behavior when serializing to XML format, XmlIgnoreAttribute should be applied to the property or field instead. Dies liegt daran, dass die-Klasse serialisiert wird XmlSerializer , indem JavaScriptSerializeranstelle von verwendet wird.This is because the class will be serialized by using XmlSerializer instead of JavaScriptSerializer.

Sie können auch ScriptIgnoreAttribute und XmlIgnoreAttribute auf eine Eigenschaft oder ein Feld anwenden.You can also apply both ScriptIgnoreAttribute and XmlIgnoreAttribute to a property or field. In diesem Fall wird die-Eigenschaft oder das-Feld für JSON-und XML-Antwortformate ignoriert.In this case, the property or field will be ignored for JSON and XML response formats.

Weitere Informationen zum Verwenden von Attributen finden Sie unter Attribute.For more information about how to use attributes, see Attributes.

Konstruktoren

ScriptIgnoreAttribute()

Initialisiert eine neue Instanz der ScriptIgnoreAttribute-Klasse.Initializes a new instance of the ScriptIgnoreAttribute class.

Eigenschaften

ApplyToOverrides

Ruft ab oder legt fest, ob die ScriptIgnoreAttribute überschrieben werden soll, so dass die JavaScriptSerializer die Serialisierung der öffentlichen Eigenschaft oder des öffentlichen Feldes berücksichtigt.Gets or set whether to override the ScriptIgnoreAttribute so that the JavaScriptSerializer will consider the serialization of the public property or public field.

TypeId

Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab.When implemented in a derived class, gets a unique identifier for this Attribute.

(Geerbt von Attribute)

Methoden

Equals(Object)

Gibt einen Wert zurück, der angibt, ob diese Instanz gleich einem angegebenen Objekt ist.Returns a value that indicates whether this instance is equal to a specified object.

(Geerbt von Attribute)
GetHashCode()

Gibt den Hashcode für diese Instanz zurück.Returns the hash code for this instance.

(Geerbt von Attribute)
GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Geerbt von Object)
IsDefaultAttribute()

Gibt beim Überschreiben in einer abgeleiteten Klasse an, ob der Wert der Instanz der Standardwert für die abgeleitete Klasse ist.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Geerbt von Attribute)
Match(Object)

Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Geerbt von Attribute)
MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Geerbt von Object)
ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Geerbt von Object)

Explizite Schnittstellenimplementierungen

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

Ordnet eine Reihe von Namen einer entsprechenden Reihe von Dispatchbezeichnern zu.Maps a set of names to a corresponding set of dispatch identifiers.

(Geerbt von Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Ruft die Typinformationen für ein Objekt ab, mit deren Hilfe die Typinformationen für eine Schnittstelle abgerufen werden können.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Geerbt von Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Ruft die Anzahl der Schnittstellen mit Typinformationen ab, die von einem Objekt bereitgestellt werden (0 oder 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Geerbt von Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Stellt den Zugriff auf von einem Objekt verfügbar gemachte Eigenschaften und Methoden bereit.Provides access to properties and methods exposed by an object.

(Geerbt von Attribute)

Gilt für: