ScriptComponentDescriptor Class

.NET Framework (current version)

Provides a wrapper for converting server components into client script.

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

Inheritance Hierarchy

System::Object
System.Web.UI::ScriptDescriptor
System.Web.UI::ScriptComponentDescriptor
System.Web.UI::ScriptBehaviorDescriptor
System.Web.UI::ScriptControlDescriptor

Syntax

C++

public ref class ScriptComponentDescriptor : ScriptDescriptor

Constructors

	Name	Description
	ScriptComponentDescriptor(String^)	Initializes an instance of the ScriptComponentDescriptor class.

Properties

	Name	Description
	ClientID	When overridden in a derived class, gets the identifier of the client component.
	ID	Gets or sets the ID of the current ScriptComponentDescriptor instance.
	Type	Gets or sets the type of the target client component.

Methods

	Name	Description
	AddComponentProperty(String^, String^)	Adds the specified property, and associates that property with the specified element.
	AddElementProperty(String^, String^)	Adds the specified property and associates that property with the specified component.
	AddEvent(String^, String^)	Adds the specified event and handler.
	AddProperty(String^, Object^)	Adds the specified property and value.
	AddScriptProperty(String^, String^)	Adds the specified property, and associates the property with the specified script.
	Equals(Object^)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetScript()	Gets the client script that implements the target control on the page.(Overrides ScriptDescriptor::GetScript().)
	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.)

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.

Version Information

.NET Framework
Available since 3.5

Thread Safety

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