ClientScriptManager.IsStartupScriptRegistered Method (Type, String)

 

Determines whether the startup script is registered with the Page object using the specified key and type.

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

member IsStartupScriptRegistered : 
        type:Type *
        key:string -> bool

Parameters

type
Type: System.Type

The type of the startup script to search for.

key
Type: System.String

The key of the startup script to search for.

Return Value

Type: System.Boolean

true if the startup script is registered; otherwise, false.

Exception Condition
ArgumentNullException

The startup script type is null.

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

A client startup script is uniquely identified by its key and its type. Scripts with the same key and type are considered duplicates.

The following code example demonstrates the use of the IsStartupScriptRegistered method. Note that, if the logic to check for the existing startup script block were removed, there would not be two duplicate startup scripts in the HTML source code of the rendered page because the RegisterStartupScript 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
Available since 2.0
Return to top
Show: