Export (0) Print
Expand All

ClientScriptItem Class

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

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

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

public sealed class ClientScriptItem

The ClientScriptItem type exposes the following members.

  NameDescription
Public methodClientScriptItemInitializes a new instance of the ClientScriptItem class using the provided parameters.
Top

  NameDescription
Public propertyIdGets the ID attribute value for the client script element.
Public propertyLanguageGets the language attribute value for the client script element.
Public propertySourceGets the src attribute value for the client script element.
Public propertyTextGets the script statements contained in the client script element.
Public propertyTypeGets the type attribute value for the client script element.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

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