This documentation is archived and is not being maintained.

ScriptComponentDescriptor Class

Provides a wrapper for converting server components into client script.

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

type ScriptComponentDescriptor =  
        inherit ScriptDescriptor

The ScriptComponentDescriptor type exposes the following members.

Public methodScriptComponentDescriptorInitializes an instance of the ScriptComponentDescriptor class.

Public propertyClientIDWhen overridden in a derived class, gets the identifier of the client component.
Public propertyIDGets or sets the ID of the current ScriptComponentDescriptor instance.
Public propertyTypeGets or sets the type of the target client component.

Public methodAddComponentPropertyAdds the specified property, and associates that property with the specified element.
Public methodAddElementPropertyAdds the specified property and associates that property with the specified component.
Public methodAddEventAdds the specified event and handler.
Public methodAddPropertyAdds the specified property and value.
Public methodAddScriptPropertyAdds the specified property, and associates the property with the specified script.
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Protected methodGetScriptGets the client script that implements the target control on the page. (Overrides ScriptDescriptor.GetScript().)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

This class uses an internal dictionary to hold references to components, elements, properties, and events. To populate this dictionary, use the AddComponentProperty, AddElementProperty, AddProperty, and AddEvent methods. When you are finished, call the GetScript method to generate the client script.

.NET Framework

Supported in: 4, 3.5

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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.