ScriptIgnoreAttribute Klasse

Definition

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

Vererbung

Object

Attribute

ScriptIgnoreAttribute

Attribute

AttributeUsageAttribute

Beispiele

Im folgenden Beispiel wird veranschaulicht, wie sie auf das Comment Feld in der benutzerdefinierten Klasse mit dem Namen Groupangewendet ScriptIgnoreAttribute werden. Dadurch wird angewiesen JavaScriptSerializer , das Feld beim Serialisieren einer Instanz der Klasse in das JSON-Format zu ignorieren.

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

Dies ScriptIgnoreAttribute hat keine Auswirkung, wenn die ResponseFormat Eigenschaft auf Xml. Wenn Sie beim Serialisieren im XML-Format das gleiche Verhalten haben möchten, XmlIgnoreAttribute sollten Sie stattdessen auf die Eigenschaft oder das Feld angewendet werden. Dies liegt daran, dass die Klasse mithilfe XmlSerializer von anstelle von JavaScriptSerializer.

Sie können auch sowohl als auch ScriptIgnoreAttributeXmlIgnoreAttribute auf eine Eigenschaft oder ein Feld anwenden. In diesem Fall wird die Eigenschaft oder das Feld für JSON- und XML-Antwortformate ignoriert.

Weitere Informationen zur Verwendung von Attributen finden Sie unter "Attribute".