ScriptIgnoreAttribute ScriptIgnoreAttribute ScriptIgnoreAttribute ScriptIgnoreAttribute Class

Определение

Указывает на то, что конструктор JavaScriptSerializer не будет выполнять сериализацию открытого свойства или поля.Specifies that JavaScriptSerializer will not serialize the public property or public field. Этот класс не наследуется.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
Наследование
ScriptIgnoreAttributeScriptIgnoreAttributeScriptIgnoreAttributeScriptIgnoreAttribute
Атрибуты

Примеры

Следующий пример демонстрирует применение ScriptIgnoreAttribute для Comment в пользовательском классе с именем Group.The following example demonstrates how to apply ScriptIgnoreAttribute to the Comment field in the custom class named Group. Это заставляет JavaScriptSerializer игнорировать это поле при сериализации экземпляра класса в формат 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

Комментарии

Если применить ScriptIgnoreAttribute открытого свойства или открытого поля класса, затем JavaScriptSerializer игнорирует или пропускает элемент при сериализации экземпляра класса в формат 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.

ScriptIgnoreAttribute Не имеет смысла, если ResponseFormat свойству Xml.The ScriptIgnoreAttribute will have no effect if the ResponseFormat property is set to Xml. Если вы хотите ведут себя так же при сериализации в формат XML, XmlIgnoreAttribute должны применяться к свойство или поле вместо него.If you want to have the same behavior when serializing to XML format, XmlIgnoreAttribute should be applied to the property or field instead. Это обусловлено тем, класс должен быть сериализован с помощью XmlSerializer вместо JavaScriptSerializer.This is because the class will be serialized by using XmlSerializer instead of JavaScriptSerializer.

Также можно применить оба ScriptIgnoreAttribute и XmlIgnoreAttribute на свойство или поле.You can also apply both ScriptIgnoreAttribute and XmlIgnoreAttribute to a property or field. В нашем примере это свойство или поле формата ответа JSON и XML будет игнорироваться.In this case, the property or field will be ignored for JSON and XML response formats.

Дополнительные сведения об использовании атрибутов см. в разделе атрибуты.For more information about how to use attributes, see Attributes.

Конструкторы

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

Инициализирует новый экземпляр класса ScriptIgnoreAttribute.Initializes a new instance of the ScriptIgnoreAttribute class.

Свойства

ApplyToOverrides ApplyToOverrides ApplyToOverrides ApplyToOverrides

Получает или задает значение, указывающее, требуется ли переопределить ScriptIgnoreAttribute так, чтобы JavaScriptSerializer рассматривал сериализацию открытого свойства или открытого поля.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

При реализации в производном классе возвращает уникальный идентификатор для этого Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Методы

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

Возвращает значение, указывающее, равен ли этот экземпляр указанному объекту.Returns a value that indicates whether this instance is equal to a specified object.

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

Возвращает хэш-код для данного экземпляра.Returns the hash code for this instance.

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

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

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

При переопределении в производном классе показывает, является ли значение данного экземпляра значением по умолчанию для производного класса.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)

При переопределении в производном классе возвращает значение, указывающее, является ли этот экземпляр равным заданному объекту.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()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

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

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Inherited from Object)

Явные реализации интерфейса

_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)

Сопоставляет набор имен соответствующему набору идентификаторов диспетчеризации.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)

Возвращает сведения о типе объекта, которые могут использоваться для получения сведений о типе интерфейса.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)

Возвращает количество предоставляемых объектом интерфейсов для доступа к сведениям о типе (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)

Предоставляет доступ к открытым свойствам и методам объекта.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Применяется к