This documentation is archived and is not being maintained.

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)

public:
void RegisterClientScriptInclude(
	Type^ type, 
	String^ key, 
	String^ url
)

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.

ExceptionCondition
ArgumentNullException

The client script include type is nullptr.

ArgumentException

The URL is nullptr.

- 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.

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

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: