Edit

Share via

ScriptManager.RegisterClientScriptResource Method

  • Reference

Definition

Namespace:
System.Web.UI
Assembly:
System.Web.Extensions.dll

Registers client script that is embedded in an assembly with the ScriptManager control for use with a control that is participating in partial-page rendering.

Overloads

RegisterClientScriptResource(Page, Type, String)

Registers a client script file that is embedded in an assembly with the ScriptManager control every time that a postback occurs.
RegisterClientScriptResource(Control, Type, String)

Registers the client script that is embedded in an assembly with the ScriptManager control for use with a control that is participating in partial-page rendering.

RegisterClientScriptResource(Page, Type, String)

Registers a client script file that is embedded in an assembly with the ScriptManager control every time that a postback occurs.

public:
 static void RegisterClientScriptResource(System::Web::UI::Page ^ page, Type ^ type, System::String ^ resourceName);
public static void RegisterClientScriptResource (System.Web.UI.Page page, Type type, string resourceName);
static member RegisterClientScriptResource : System.Web.UI.Page * Type * string -> unit
Public Shared Sub RegisterClientScriptResource (page As Page, type As Type, resourceName As String)

Parameters

page
Page

The page object that is registering the script.

type
Type

The type of the client script. This parameter is usually specified by using the typeof operator (C#) or the GetType operator (Visual Basic) to retrieve the type of the control that is registering the script.

resourceName
String

An identifier for the resource.

Exceptions

ArgumentNullException

The client resource type is null.

-or-

The page that is registering the script is null.

Remarks

When you register a script file with this method, the script is rendered every time that an asynchronous postback occurs. To register a script for a control that is inside an UpdatePanel control so that the script is registered only when the UpdatePanel control is updated, use the RegisterClientScriptResource(Control, Type, String) overload of this method.

If you want to register a script block that does not pertain to partial-page updates, and if you want to register the script block only one time during initial page rendering, use the RegisterClientScriptBlock method of the ClientScriptManager class. You can get a reference to the ClientScriptManager object from the ClientScript property of the page.

See also

Applies to

RegisterClientScriptResource(Control, Type, String)

Registers the client script that is embedded in an assembly with the ScriptManager control for use with a control that is participating in partial-page rendering.

public:
 static void RegisterClientScriptResource(System::Web::UI::Control ^ control, Type ^ type, System::String ^ resourceName);
public static void RegisterClientScriptResource (System.Web.UI.Control control, Type type, string resourceName);
static member RegisterClientScriptResource : System.Web.UI.Control * Type * string -> unit
Public Shared Sub RegisterClientScriptResource (control As Control, type As Type, resourceName As String)

Parameters

control
Control

The control that is registering the script.

type
Type

The type of the client script. This parameter is usually specified by using the typeof operator (C#) or the GetType operator (Visual Basic) to retrieve the type of the control that is registering the script.

resourceName
String

An identifier for the resource.

Exceptions

ArgumentNullException

The client resource type is null.

-or-

The control that is registering the script is null.

ArgumentException

The control that is registering the script is not in the page's control tree.

Remarks

You use the RegisterClientScriptResource method to register a script that is compatible with partial-page rendering and that has no Microsoft Ajax Library dependencies. Script resources that are registered by using this method are registered only when control represents a control that is inside an UpdatePanel control that is updated. To register a script every time that an asynchronous postback occurs, use the RegisterStartupScript(Page, Type, String, String, Boolean) overload of this method.

If you want to register a script block that does not pertain to partial-page updates, and if you want to register the script block only one time during initial page rendering, use the RegisterClientScriptBlock method of the ClientScriptManager class. You can get a reference to the ClientScriptManager object from the ClientScript property of the page.

The RegisterClientScriptResource method is used when resources from assemblies are accessed through an HTTP handler. This method includes the content of the resource URL in a script element.

Both the RegisterClientScriptInclude and the RegisterClientScriptResource method load script files into the browser. If a script with the same type and key (for a script file) or the same type and resource name (for an embedded resource) is already loaded, the script is not reloaded.

See also

Applies to