ScriptIgnoreAttribute Класс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Указывает, что 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
- Наследование
- Атрибуты
Примеры
В следующем примере показано, как применяться 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).
Значение не будет иметь никакого ResponseFormat эффекта, ScriptIgnoreAttribute если для свойства задано Xmlзначение . Если при сериализации в xml-формате требуется такое же поведение, XmlIgnoreAttribute следует применить к свойству или полю. Это связано с тем, что класс будет сериализован вместо XmlSerializerJavaScriptSerializer.
Можно также применить как к свойству, так 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) |