ScriptIgnoreAttribute Класс

Определение

Пространство имен:

System.Web.Script.Serialization

Сборка:

System.Web.Extensions.dll

Указывает на то, что конструктор JavaScriptSerializer не будет выполнять сериализацию открытого свойства или поля. Этот класс не наследуется.

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

Наследование

Object

Attribute

ScriptIgnoreAttribute

Атрибуты

AttributeUsageAttribute

Примеры

В следующем примере показано, как применить к ScriptIgnoreAttribute полю Comment в пользовательском классе с именем Group. Это указывает JavaScriptSerializer игнорировать поле при сериализации экземпляра класса в формат 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

Комментарии

Если вы применяете к ScriptIgnoreAttribute открытому свойству или открытому полю класса, то JavaScriptSerializer игнорирует или пропускает элемент при сериализации экземпляра класса в формат нотации объектов JavaScript (JSON).

Это ScriptIgnoreAttribute действие не повлияет, если ResponseFormat свойству Xmlприсвоено значение . Если при сериализации в xml-формате требуется такое же поведение, XmlIgnoreAttribute следует применить к свойству или полю. Это связано с тем, что класс будет сериализован с помощью XmlSerializer вместо JavaScriptSerializer.

Можно также применить как к свойству, так ScriptIgnoreAttribute и XmlIgnoreAttribute к полю. В этом случае свойство или поле будут игнорироваться для форматов ответов JSON и XML.

Дополнительные сведения об использовании атрибутов см. в разделе "Атрибуты".

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

ScriptIgnoreAttribute()

Инициализирует новый экземпляр класса ScriptIgnoreAttribute.

Свойства

ApplyToOverrides	Получает или задает значение, указывающее, требуется ли переопределить ScriptIgnoreAttribute так, чтобы JavaScriptSerializer рассматривал сериализацию открытого свойства или открытого поля.
TypeId	В случае реализации в производном классе возвращает уникальный идентификатор для этого атрибута Attribute. (Унаследовано от Attribute)

Методы

Equals(Object)	Возвращает значение, показывающее, равен ли экземпляр указанному объекту. (Унаследовано от Attribute)
GetHashCode()	Возвращает хэш-код данного экземпляра. (Унаследовано от Attribute)
GetType()	Возвращает объект Type для текущего экземпляра. (Унаследовано от Object)
IsDefaultAttribute()	При переопределении в производном классе указывает, является ли значение этого экземпляра значением по умолчанию для производного класса. (Унаследовано от Attribute)
Match(Object)	При переопределении в производном классе возвращает значение, указывающее, является ли этот экземпляр равным заданному объекту. (Унаследовано от Attribute)
MemberwiseClone()	Создает неполную копию текущего объекта Object. (Унаследовано от Object)
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)

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

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Сопоставляет набор имен соответствующему набору идентификаторов диспетчеризации. (Унаследовано от Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Возвращает сведения о типе объекта, которые можно использовать для получения сведений о типе интерфейса. (Унаследовано от Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Возвращает количество предоставляемых объектом интерфейсов для доступа к сведениям о типе (0 или 1). (Унаследовано от Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Предоставляет доступ к открытым свойствам и методам объекта. (Унаследовано от Attribute)