Export (0) Print
Expand All

ClientScriptItem Class

Note: This class is new in the .NET Framework version 2.0.

Represents a client script element in a Web Form or user control at design time. This class cannot be inherited.

Namespace: System.Web.UI.Design
Assembly: System.Design (in system.design.dll)

public sealed class ClientScriptItem
public final class ClientScriptItem
public final class ClientScriptItem

The ClientScriptItem class represents a script element that is contained in a Web document at design time. A custom control designer implementation can use a ClientScriptItem object to add client script elements to a Web Form or user control.

At design time, use the WebFormsRootDesigner class to set or examine client script elements that are contained in a document, such as a Web form, a Web server control, a content page, or a master page, on the design surface. Retrieve the collection of client script elements that are contained within the Web document by using the GetClientScriptsInDocument method. Add a client script element to the Web document by using the AddClientScriptToDocument method.

Typically, a script element either contains script statements or specifies an external location for script statements. The script element can optionally define the language of the script statements. Use the ClientScriptItem constructor to initialize the properties for a new script object. Use the ClientScriptItem properties to examine the script object attributes and contents. The Language property represents the language attribute of the script element. The Source property represents the src attribute. The Text property represents the script statements to be executed on the client that are contained in the script element.

Use the ClientScriptItem class to manage scripts that are to be executed at design-time.

To manage client script elements at run time, use the ClientScriptManager class. For more information about using client scripts at run time, see Client Script in ASP.NET Web Pages.

NoteNote

The ClientScriptItem class represents script elements at design time that are ultimately parsed and run in the client browser. Because the script elements that are generated for the ClientScriptItem objects are not run on the server, the elements do not contain the runat="server" attribute.

System.Object
  System.Web.UI.Design.ClientScriptItem

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0
Show:
© 2014 Microsoft