This documentation is archived and is not being maintained.

ClientScriptManager::IsClientScriptBlockRegistered Method (Type, String)

Determines whether the client script block is registered with the Page object using a key and type.

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

public:
bool IsClientScriptBlockRegistered(
	Type^ type, 
	String^ key
)

Parameters

type
Type: System::Type
The type of the client script block to search for.
key
Type: System::String
The key of the client script block to search for.

Return Value

Type: System::Boolean
true if the client script block is registered; otherwise, false.

ExceptionCondition
ArgumentNullException

The client script type is nullptr.

Call this method before calling the RegisterClientScriptBlock method to avoid registering duplicate scripts. This is particularly important if the script requires a large amount of server resources to create.

A client script is uniquely identified by its key and its type. Scripts with the same key and type are considered duplicates. 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.

The following code example demonstrates the use of the IsClientScriptBlockRegistered method. Note that, if the logic to check for the existing client script block were removed, there would not be two duplicate client scripts in the HTML source code of the rendered page because the RegisterClientScriptBlock 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.

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