ScriptIgnoreAttribute.xml

<Type Name="ScriptIgnoreAttribute" FullName="System.Web.Script.Serialization.ScriptIgnoreAttribute">
  <TypeSignature Language="C#" Value="public sealed class ScriptIgnoreAttribute : Attribute" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit ScriptIgnoreAttribute extends System.Attribute" />
  <TypeSignature Language="DocId" Value="T:System.Web.Script.Serialization.ScriptIgnoreAttribute" />
  <TypeSignature Language="VB.NET" Value="Public NotInheritable Class ScriptIgnoreAttribute&#xA;Inherits Attribute" />
  <TypeSignature Language="F#" Value="type ScriptIgnoreAttribute = class&#xA;    inherit Attribute" />
  <TypeSignature Language="C++ CLI" Value="public ref class ScriptIgnoreAttribute sealed : Attribute" />
  <AssemblyInfo>
    <AssemblyName>System.Web.Extensions</AssemblyName>
    <AssemblyVersion>3.5.0.0</AssemblyVersion>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Attribute</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes>
    <Attribute FrameworkAlternate="netframework-3.5;netframework-4.0">
      <AttributeName Language="C#">[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property)]</AttributeName>
      <AttributeName Language="F#">[&lt;System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property)&gt;]</AttributeName>
    </Attribute>
    <Attribute FrameworkAlternate="netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1">
      <AttributeName Language="C#">[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=false, Inherited=true)]</AttributeName>
      <AttributeName Language="F#">[&lt;System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=false, Inherited=true)&gt;]</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>Specifies that <see cref="T:System.Web.Script.Serialization.JavaScriptSerializer" /> will not serialize the public property or public field. This class cannot be inherited.</summary>
    <remarks>
      <format type="text/markdown"><![CDATA[

## Remarks
 If you apply <xref:System.Web.Script.Serialization.ScriptIgnoreAttribute> to a public property or public field of a class, then <xref:System.Web.Script.Serialization.JavaScriptSerializer> ignores, or skips, the member when serializing an instance of the class to JavaScript Object Notation (JSON) format.

 The <xref:System.Web.Script.Serialization.ScriptIgnoreAttribute> will have no effect if the <xref:System.Web.Script.Services.ScriptMethodAttribute.ResponseFormat> property is set to `Xml`. If you want to have the same behavior when serializing to XML format, <xref:System.Xml.Serialization.XmlIgnoreAttribute> should be applied to the property or field instead. This is because the class will be serialized by using <xref:System.Xml.Serialization.XmlSerializer> instead of <xref:System.Web.Script.Serialization.JavaScriptSerializer>.

 You can also apply both <xref:System.Web.Script.Serialization.ScriptIgnoreAttribute> and <xref:System.Xml.Serialization.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 [Attributes](/dotnet/standard/attributes/).



## Examples
 The following example demonstrates how to apply <xref:System.Web.Script.Serialization.ScriptIgnoreAttribute> to the `Comment` field in the custom class named `Group`. This instructs <xref:System.Web.Script.Serialization.JavaScriptSerializer> to ignore the field when serializing an instance of the class to JSON format.

 :::code language="csharp" source="~/snippets/csharp/VS_Snippets_Atlas/System.Web.Script.Serialization.ScriptIgnoreAttribute/CS/App_Code/ScriptIgnoreSample.cs" id="Snippet1":::
 :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Atlas/System.Web.Script.Serialization.ScriptIgnoreAttribute/VB/App_Code/ScriptIgnoreSample.vb" id="Snippet1":::

 ]]></format>
    </remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ScriptIgnoreAttribute ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Web.Script.Serialization.ScriptIgnoreAttribute.#ctor" />
      <MemberSignature Language="VB.NET" Value="Public Sub New ()" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; ScriptIgnoreAttribute();" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Web.Extensions</AssemblyName>
        <AssemblyVersion>3.5.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <Parameters />
      <Docs>
        <summary>Initializes a new instance of the <see cref="T:System.Web.Script.Serialization.ScriptIgnoreAttribute" /> class.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ApplyToOverrides">
      <MemberSignature Language="C#" Value="public bool ApplyToOverrides { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool ApplyToOverrides" />
      <MemberSignature Language="DocId" Value="P:System.Web.Script.Serialization.ScriptIgnoreAttribute.ApplyToOverrides" />
      <MemberSignature Language="VB.NET" Value="Public Property ApplyToOverrides As Boolean" />
      <MemberSignature Language="F#" Value="member this.ApplyToOverrides : bool with get, set" Usage="System.Web.Script.Serialization.ScriptIgnoreAttribute.ApplyToOverrides" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property bool ApplyToOverrides { bool get(); void set(bool value); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Web.Extensions</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets or set whether to override the <see cref="T:System.Web.Script.Serialization.ScriptIgnoreAttribute" /> so that the <see cref="T:System.Web.Script.Serialization.JavaScriptSerializer" /> will consider the serialization of the public property or public field.</summary>
        <value>
          <see langword="true" /> to override the <see cref="T:System.Web.Script.Serialization.ScriptIgnoreAttribute" />; otherwise, <see langword="false" />.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>