ClientScriptManager.RegisterClientScriptInclude Method (Type, String, String)

 

Registers the client script include with the Page object using a type, a key, and a URL.

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

member RegisterClientScriptInclude : 
        type:Type *
        key:string *
        url:string -> unit

Parameters

type
Type: System.Type

The type of the client script include to register.

key
Type: System.String

The key of the client script include to register.

url
Type: System.String

The URL of the client script include to register.

Exception Condition
ArgumentNullException

The client script include type is null.

ArgumentException

The URL is null.

- or -

The URL is empty.

This overload of the RegisterClientScriptInclude method takes key and url parameters to identify the script, as well as a type parameter to specify the identification of the client script include. You specify the type based on the object that will be accessing the resource. For instance, when using a Page instance to access the resource, you specify the Page type.

System_CAPS_noteNote

To resolve the client URL, use the ResolveClientUrl method. This method uses the context of the URL on which it is called to resolve the path.

This method adds a script block at the top of the rendered page.

The following code example demonstrates the use of the RegisterClientScriptInclude method. Note that if the logic to check for the existing client script include were removed, there would still not be duplicate client scripts in the rendered page because the RegisterClientScriptInclude method checks for duplicates. The benefit of checking is to reduce unnecessary computation.

No code example is currently available or this language may not be supported.

This example requires a JavaScript file named Script_include.js with the following contents:

function DoClick() {Form1.Message.value='Text from include script.'}

.NET Framework
Available since 2.0
Return to top
Show: