ScriptReferenceEventArgs Class
Collapse the table of content
Expand the table of content

ScriptReferenceEventArgs Class


Provides data for the ResolveScriptReference event.

Namespace:   System.Web.UI
Assembly:  System.Web.Extensions (in System.Web.Extensions.dll)


public class ScriptReferenceEventArgs : EventArgs


Initializes a new instance of the ScriptReferenceEventArgs class.


Gets the ScriptReference object that contains the script library.


Determines whether the specified object is equal to the current object.(Inherited from Object.)


Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)


Serves as the default hash function. (Inherited from Object.)


Gets the Type of the current instance.(Inherited from Object.)


Creates a shallow copy of the current Object.(Inherited from Object.)


Returns a string that represents the current object.(Inherited from Object.)

When a script reference is rendered, the ScriptReferenceEventArgs object contains the ScriptReference object that is defined in the ScriptManager instance. You can create an event handler for the ResolveScriptReference event to check the ScriptReference object and modify it as needed.

The following example shows an ASP.NET Web page that references a script file that is named CustomScript.js. When the Web application is hosted on the domain, the Path property is set to a value specific for that domain. An event handler for the ResolveScriptReference event checks the host URL and changes the value for the Path property if it is necessary.

<%@ Page Language="C#" AutoEventWireup="true" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "">

<script runat="server">
    protected void ScriptManager1_ResolveScriptReference(object sender, ScriptReferenceEventArgs e)
        if (e.Script.Path.Contains("CustomScript"))
            if (HttpContext.Current.Request.Url.Host.ToLower() == "")
                e.Script.Path = "";

<html xmlns="" >
<head runat="server">
    <title>Script Reference Example</title>
    <form id="form1" runat="server">
        <asp:ScriptManager OnResolveScriptReference="ScriptManager1_ResolveScriptReference" ID="ScriptManager1" runat="server">
            <asp:ScriptReference Path="~/scripts/CustomScript.js" />

.NET Framework
Available since 3.5

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
© 2015 Microsoft