ClientScriptItem Class

Reference

Definition

Namespace:: System.Web.UI.Design

Assembly:: System.Design.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public ref class ClientScriptItem sealed

public sealed class ClientScriptItem

type ClientScriptItem = class

Public NotInheritable Class ClientScriptItem

Inheritance: Object
ClientScriptItem

Remarks

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.

Note

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.

Constructors

ClientScriptItem(String, String, String, String, String)

Initializes a new instance of the ClientScriptItem class using the provided parameters.

Properties

Id	Gets the `ID` attribute value for the client script element.
Language	Gets the `language` attribute value for the client script element.
Source	Gets the `src` attribute value for the client script element.
Text	Gets the script statements contained in the client script element.
Type	Gets the `type` attribute value for the client script element.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Applies to

Dela via