Documentation for: ASP.NET Ajax Version 1.0

This documentation is for a previous version. For the current released version, see the ASP.NET Ajax documentation on MSDN.

 

 

 

 

 

 

 

ScriptIgnoreAttribute Class

Specifies that JavaScriptSerializer will not serialize the public property or public field. This class cannot be inherited.

Syntax

CSharp

[AttributeUsageAttribute(AttributeTargets.Property|AttributeTargets.Field)]
[AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level = AspNetHostingPermissionLevel.Minimal)]
public sealed class ScriptIgnoreAttribute : Attribute

VisualBasic

<AttributeUsageAttribute(AttributeTargets.Property Or AttributeTargets.Field)> _
<AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level := AspNetHostingPermissionLevel.Minimal)> _
Public NotInheritable Class ScriptIgnoreAttribute _
	Inherits Attribute

ManagedCPlusPlus

[AttributeUsageAttribute(AttributeTargets::Property|AttributeTargets::Field)]
[AspNetHostingPermissionAttribute(SecurityAction::LinkDemand, Level = AspNetHostingPermissionLevel::Minimal)]
public ref class ScriptIgnoreAttribute sealed : public Attribute

JSharp

/** @attribute AttributeUsageAttribute(AttributeTargets.Property|AttributeTargets.Field) */
/** @attribute AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level = AspNetHostingPermissionLevel.Minimal) */
public final class ScriptIgnoreAttribute extends Attribute

Members

IconMemberDescription
ScriptIgnoreAttributeNew()Initializes a new instance of the ScriptIgnoreAttribute class.
Equals(Object)Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Finalize()Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
GetHashCode()Returns the hash code for this instance. (Inherited from Attribute.)
GetType()Gets the Type of the current instance. (Inherited from Object.)
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)When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
MemberwiseClone()Creates a shallow copy of the current Object. (Inherited from Object.)
ToString()Returns a String that represents the current Object. (Inherited from Object.)
TypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)

Remarks

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 JSON format.

The ScriptIgnoreAttribute will have no effect if the ResponseFormat property is set to Xml. If you want to have the same behavior when serializing to XML format, XmlIgnoreAttribute should be applied to the property or field instead. This is because the class will be serialized by using XmlSerializer instead of JavaScriptSerializer.

You can also apply both ScriptIgnoreAttribute and XmlIgnoreAttribute to a property or field. 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 Extending Metadata Using Attributes.

Examples

The following example demonstrates how to apply ScriptIgnoreAttribute to the Comment field in the custom class named Group. This instructs JavaScriptSerializer to ignore the field when serializing an instance of the class to JSON format.

App_Code

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;
}

App_Code

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

Permissions

  • AspNetHostingPermission

    for operating in a hosted environment. Demand value: LinkDemand. Associated enumeration: Minimal.

Inheritance Hierarchy

Object

Assembly: System.Web.Extensions (Module: System.Web.Extensions)