ScriptMode.xml

<Type Name="ScriptMode" FullName="System.Web.UI.ScriptMode">
  <TypeSignature Language="C#" Value="public enum ScriptMode" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed ScriptMode extends System.Enum" />
  <TypeSignature Language="DocId" Value="T:System.Web.UI.ScriptMode" />
  <TypeSignature Language="VB.NET" Value="Public Enum ScriptMode" />
  <TypeSignature Language="F#" Value="type ScriptMode = " />
  <TypeSignature Language="C++ CLI" Value="public enum class ScriptMode" />
  <AssemblyInfo>
    <AssemblyName>System.Web.Extensions</AssemblyName>
    <AssemblyVersion>3.5.0.0</AssemblyVersion>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Enum</BaseTypeName>
  </Base>
  <Docs>
    <summary>Specifies whether <see cref="T:System.Web.UI.ScriptManager" /> and <see cref="T:System.Web.UI.ScriptReference" /> objects refer to the debug or release version of client scripts.</summary>
    <remarks>
      <format type="text/markdown"><![CDATA[  
  
## Remarks  
 The <xref:System.Web.UI.ScriptMode> enumeration provides values for setting the version of client script to use on a Web page. The enumeration values can be applied to either the <xref:System.Web.UI.ScriptManager.ScriptMode%2A?displayProperty=nameWithType> property  or to the [ScriptReference.ScriptMode](<xref:System.Web.UI.ScriptReferenceBase.ScriptMode%2A>) property. The <xref:System.Web.UI.ScriptManager> object sets the version for all scripts on the page unless it is overridden by a <xref:System.Web.UI.ScriptReference> object. The <xref:System.Web.UI.ScriptReference> object sets the version for a particular script.  
  
 The <xref:System.Web.UI.ScriptMode.Auto?displayProperty=nameWithType> value produces different results depending on whether it refers to a standalone script file or to a script file that is embedded as a resource in an assembly. A standalone script file is defined with the [ScriptReference.Path](<xref:System.Web.UI.ScriptReferenceBase.Path%2A>) property. An assembly reference must be accessed through the <xref:System.Web.UI.ScriptReference.Name%2A> and <xref:System.Web.UI.ScriptReference.Assembly%2A> properties. The results for the <xref:System.Web.UI.ScriptMode.Auto?displayProperty=nameWithType> value are as follows:  
  
-   When it is applied to a standalone script file where the [ScriptReference.Path]<xref:System.Web.UI.ScriptReferenceBase.Path%2A> property is specified, the <xref:System.Web.UI.ScriptMode.Auto?displayProperty=nameWithType> value is equivalent to <xref:System.Web.UI.ScriptMode.Release?displayProperty=nameWithType>.  
  
-   When it is applied to a script reference in an assembly, <xref:System.Web.UI.ScriptMode.Auto?displayProperty=nameWithType> is equivalent to <xref:System.Web.UI.ScriptMode.Inherit?displayProperty=nameWithType>. When only <xref:System.Web.UI.ScriptReference.Name%2A> is specified, it is used to reference the script. When <xref:System.Web.UI.ScriptReference.Name%2A> and the [ScriptReference.Path]<xref:System.Web.UI.ScriptReferenceBase.Path%2A> property are both specified, the [ScriptReference.Path]<xref:System.Web.UI.ScriptReferenceBase.Path%2A> property is used instead of <xref:System.Web.UI.ScriptReference.Name%2A>, but the <xref:System.Web.UI.ScriptMode.Auto?displayProperty=nameWithType> value is still equivalent to <xref:System.Web.UI.ScriptMode.Inherit?displayProperty=nameWithType>.  
  
 An error is thrown if the requested version of the script does not exist. For instance, an error is thrown if a reference is made to a standalone script file that is named CustomScript.js and the <xref:System.Web.UI.ScriptManager.ScriptMode%2A?displayProperty=nameWithType> property is set to <xref:System.Web.UI.ScriptMode.Debug?displayProperty=nameWithType>, but CustomScript.debug.js does not exist on the site. References to scripts in an assembly return the release version if the debug version does not exist.  
  
> [!NOTE]
>  When the `retail` attribute of the [deployment](https://msdn.microsoft.com/library/dbcc2c62-3159-4a62-9f1e-8cfe3b8b09dc) element of the Machine.config file is set to `true`, the release versions of client scripts are used throughout the Web site. The <xref:System.Web.UI.ScriptMode> values in the <xref:System.Web.UI.ScriptManager.ScriptMode%2A?displayProperty=nameWithType> and [ScriptReference.ScriptMode](<xref:System.Web.UI.ScriptReferenceBase.ScriptMode%2A>) properties are ignored.  
  
   
  
## Examples  
 The following example shows a page where the script versions are declaratively set to Release in the <xref:System.Web.UI.ScriptManager> control, but one script named CustomClient.js is declaratively set to Debug in the <xref:System.Web.UI.ScriptReference.Name%2A> control.  
  
 :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_Atlas/System.Web.UI.ScriptMode/cs/Default.aspx" id="Snippet1":::
 :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_Atlas/System.Web.UI.ScriptMode/vb/Default.aspx" id="Snippet1":::  
  
 ]]></format>
    </remarks>
  </Docs>
  <Members>
    <Member MemberName="Auto">
      <MemberSignature Language="C#" Value="Auto" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Web.UI.ScriptMode Auto = int32(0)" />
      <MemberSignature Language="DocId" Value="F:System.Web.UI.ScriptMode.Auto" />
      <MemberSignature Language="VB.NET" Value="Auto" />
      <MemberSignature Language="F#" Value="Auto = 0" Usage="System.Web.UI.ScriptMode.Auto" />
      <MemberSignature Language="C++ CLI" Value="Auto" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Web.Extensions</AssemblyName>
        <AssemblyVersion>3.5.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Web.UI.ScriptMode</ReturnType>
      </ReturnValue>
      <MemberValue>0</MemberValue>
      <Docs>
        <summary>In the <see cref="T:System.Web.UI.ScriptManager" /> control, the version of client scripts to use is determined at run time based on the application-level [&lt;compilation&gt;](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/s10awwz0(v=vs.100)) element of the Web.config file, unless it is overridden in an instance of the <see cref="T:System.Web.UI.ScriptReference" /> control. In the <see cref="T:System.Web.UI.ScriptReference" /> control, when applied to a standalone script file, <see cref="F:System.Web.UI.ScriptMode.Auto" /> is equivalent to <see cref="F:System.Web.UI.ScriptMode.Release" />. When applied to a script reference in an assembly, <see cref="F:System.Web.UI.ScriptMode.Auto" /> is equivalent to <see cref="F:System.Web.UI.ScriptMode.Inherit" />.</summary>
      </Docs>
    </Member>
    <Member MemberName="Debug">
      <MemberSignature Language="C#" Value="Debug" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Web.UI.ScriptMode Debug = int32(2)" />
      <MemberSignature Language="DocId" Value="F:System.Web.UI.ScriptMode.Debug" />
      <MemberSignature Language="VB.NET" Value="Debug" />
      <MemberSignature Language="F#" Value="Debug = 2" Usage="System.Web.UI.ScriptMode.Debug" />
      <MemberSignature Language="C++ CLI" Value="Debug" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Web.Extensions</AssemblyName>
        <AssemblyVersion>3.5.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Web.UI.ScriptMode</ReturnType>
      </ReturnValue>
      <MemberValue>2</MemberValue>
      <Docs>
        <summary>In the <see cref="T:System.Web.UI.ScriptManager" /> control, the debug version of the client script is used on the Web page unless overridden in an instance of the <see cref="T:System.Web.UI.ScriptReference" /> control. In the <see cref="T:System.Web.UI.ScriptReference" /> control, the debug version of the client script is used on the Web page.</summary>
      </Docs>
    </Member>
    <Member MemberName="Inherit">
      <MemberSignature Language="C#" Value="Inherit" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Web.UI.ScriptMode Inherit = int32(1)" />
      <MemberSignature Language="DocId" Value="F:System.Web.UI.ScriptMode.Inherit" />
      <MemberSignature Language="VB.NET" Value="Inherit" />
      <MemberSignature Language="F#" Value="Inherit = 1" Usage="System.Web.UI.ScriptMode.Inherit" />
      <MemberSignature Language="C++ CLI" Value="Inherit" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Web.Extensions</AssemblyName>
        <AssemblyVersion>3.5.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Web.UI.ScriptMode</ReturnType>
      </ReturnValue>
      <MemberValue>1</MemberValue>
      <Docs>
        <summary>In the <see cref="T:System.Web.UI.ScriptManager" /> control, <see cref="F:System.Web.UI.ScriptMode.Inherit" /> is equivalent to <see cref="F:System.Web.UI.ScriptMode.Auto" />. In the <see cref="T:System.Web.UI.ScriptReference" /> control, the <see cref="P:System.Web.UI.ScriptManager.ScriptMode" /> value from <see cref="T:System.Web.UI.ScriptManager" /> determines which version of the client script to use.</summary>
      </Docs>
    </Member>
    <Member MemberName="Release">
      <MemberSignature Language="C#" Value="Release" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Web.UI.ScriptMode Release = int32(3)" />
      <MemberSignature Language="DocId" Value="F:System.Web.UI.ScriptMode.Release" />
      <MemberSignature Language="VB.NET" Value="Release" />
      <MemberSignature Language="F#" Value="Release = 3" Usage="System.Web.UI.ScriptMode.Release" />
      <MemberSignature Language="C++ CLI" Value="Release" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Web.Extensions</AssemblyName>
        <AssemblyVersion>3.5.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Web.UI.ScriptMode</ReturnType>
      </ReturnValue>
      <MemberValue>3</MemberValue>
      <Docs>
        <summary>In the <see cref="T:System.Web.UI.ScriptManager" /> control, the release version of the client script is used on the Web page unless overridden by setting the <see cref="P:System.Web.UI.ScriptReferenceBase.ScriptMode" /> property of a <see cref="T:System.Web.UI.ScriptReference" /> instance to <see cref="F:System.Web.UI.ScriptMode.Debug" />. In the <see cref="T:System.Web.UI.ScriptReference" /> control, the release version of the client script is used on the Web page.</summary>
      </Docs>
    </Member>
  </Members>
</Type>