System.Web.UI.Design.ClientScriptItem Class

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

See Also: ClientScriptItem Members


public sealed class ClientScriptItem


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

At design time, use the System.Web.UI.Design.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 WebFormsRootDesigner.GetClientScriptsInDocument method. Add a client script element to the Web document by using the WebFormsRootDesigner.AddClientScriptToDocument(ClientScriptItem) 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.#ctor(string, string, string, string, string) constructor to initialize the properties for a new script object. Use the System.Web.UI.Design.ClientScriptItem properties to examine the script object attributes and contents. The ClientScriptItem.Language property represents the language attribute of the script element. The ClientScriptItem.Source property represents the src attribute. The ClientScriptItem.Text property represents the script statements to be executed on the client that are contained in the script element.

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

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


The System.Web.UI.Design.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 System.Web.UI.Design.ClientScriptItem objects are not run on the server, the elements do not contain the runat="server" attribute.


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