Export (0) Print
Expand All

IExtenderControl Interface

Defines the behavior for an extender control.

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

public interface IExtenderControl

The IExtenderControl type exposes the following members.

  NameDescription
Public methodGetScriptDescriptorsRegisters the ScriptDescriptor objects for the control and returns an object that contains the ScriptDescriptor objects for the control.
Public methodGetScriptReferencesRegisters the script libraries for the control and returns an enumeration of ECMAScript (JavaScript) files that have been registered as embedded resources.
Top

Extender controls that derive from the ExtenderControl class require a ScriptManager control to be on the page. The ExtenderControl base class performs an explicit test to make sure that a ScriptManager control exists on the page.

However, if you want to create extender controls and the page does not contain an ScriptManager control, you can create a class that implements the IExtenderControl interface directly. Additionally, if you are creating a class that derives from Control or you are extending an existing control that derives from Control, you can implement the IExtenderControl interface to support client functionality.

The IExtenderControl interface registers the script libraries for a control by calling the GetScriptReferences method, and it registers ScriptDescriptor objects by calling the GetScriptDescriptors method. The GetScriptDescriptors method returns an IEnumerable list of ScriptDescriptor objects.

NoteNote

If you extend an existing control type that is derived from the WebControl class, implement the IScriptControl interface.

To create an extender control by implementing IExtenderControl, you do the following:

  • Write code for the control's OnInit event to detect and use the ScriptManager control if it is available on the page.

  • If the ScriptManager is not available on the page, provide alternative means to register required scripts by calling static methods of the ScriptManager class.

  • Provide protected virtual members for IExtenderControl members.

  • Provide instance script as a script block that you register with the ScriptManager control. You must do this during the control's PreRender, PreRenderComplete, or Render events.

  • Register the script descriptors during the control's Render event.

NoteNote

If the page contains an UpdatePanel control, the page must contain a ScriptManager control. You must implement the IExtenderControl interface only when the page does not contain a ScriptManager control.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5

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.

Show:
© 2014 Microsoft