IExtenderControl IExtenderControl IExtenderControl IExtenderControl Interface

定義

エクステンダー コントロールの動作を定義します。Defines the behavior for an extender control.

public interface class IExtenderControl
public interface IExtenderControl
type IExtenderControl = interface
Public Interface IExtenderControl
派生

注釈

ExtenderControlクラスから派生するエクステンダーコントロールでは、 ScriptManagerコントロールをページ上に配置する必要があります。Extender controls that derive from the ExtenderControl class require a ScriptManager control to be on the page. 基本ExtenderControlクラスは、 ScriptManagerコントロールがページ上に存在することを確認するために、明示的なテストを実行します。The ExtenderControl base class performs an explicit test to make sure that a ScriptManager control exists on the page.

ただし、エクステンダーコントロールを作成するときに、そのページにScriptManagerコントロールが含まれていない場合は、 IExtenderControlインターフェイスを直接実装するクラスを作成できます。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. また、からControl派生するクラスを作成する場合、またはからControl派生した既存のコントロールを拡張する場合は、 IExtenderControlクライアント機能をサポートするインターフェイスを実装できます。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.

インターフェイスIExtenderControlは、 GetScriptReferencesメソッドを呼び出してコントロールのスクリプトライブラリを登録し、 GetScriptDescriptorsメソッドをScriptDescriptor呼び出すことによってオブジェクトを登録します。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. メソッドGetScriptDescriptorsは、オブジェクトIEnumerableScriptDescriptor一覧を返します。The GetScriptDescriptors method returns an IEnumerable list of ScriptDescriptor objects.

注意

WebControlクラスから派生した既存のコントロール型を拡張する場合は、 IScriptControlインターフェイスを実装します。If you extend an existing control type that is derived from the WebControl class, implement the IScriptControl interface.

を実装IExtenderControlしてエクステンダーコントロールを作成するには、次の操作を行います。To create an extender control by implementing IExtenderControl, you do the following:

  • コントロールのOnInitイベントのコードを記述して、 ScriptManagerコントロールがページ上で使用可能な場合はそれを検出して使用します。Write code for the control's OnInit event to detect and use the ScriptManager control if it is available on the page.

  • がページで使用できない場合は、 ScriptManagerクラスの静的メソッドを呼び出すことによって、必要なスクリプトを登録するための代替手段を提供します。 ScriptManagerIf the ScriptManager is not available on the page, provide alternative means to register required scripts by calling static methods of the ScriptManager class.

  • メンバーの保護されIExtenderControlた仮想メンバーを指定してください。Provide protected virtual members for IExtenderControl members.

  • インスタンススクリプトを、 ScriptManagerコントロールに登録するスクリプトブロックとして指定します。Provide instance script as a script block that you register with the ScriptManager control. この操作は、コントロールのPreRenderPreRenderComplete、またはRenderイベントの実行中に行う必要があります。You must do this during the control's PreRender, PreRenderComplete, or Render events.

  • コントロールのRenderイベント中にスクリプト記述子を登録します。Register the script descriptors during the control's Render event.

注意

ページにUpdatePanelコントロールが含まれている場合、そのページScriptManagerにはコントロールが含まれている必要があります。If the page contains an UpdatePanel control, the page must contain a ScriptManager control. IExtenderControlインターフェイスを実装する必要があるのは、ページにScriptManagerコントロールが含まれていない場合のみです。You must implement the IExtenderControl interface only when the page does not contain a ScriptManager control.

メソッド

GetScriptDescriptors(Control) GetScriptDescriptors(Control) GetScriptDescriptors(Control) GetScriptDescriptors(Control)

コントロールの ScriptDescriptor オブジェクトを登録し、コントロールの ScriptDescriptor オブジェクトを格納しているオブジェクトを返します。Registers the ScriptDescriptor objects for the control and returns an object that contains the ScriptDescriptor objects for the control.

GetScriptReferences() GetScriptReferences() GetScriptReferences() GetScriptReferences()

コントロールのスクリプト ライブラリを登録し、埋め込みリソースとして登録された ECMAScript (JavaScript) ファイルの列挙体を返します。Registers the script libraries for the control and returns an enumeration of ECMAScript (JavaScript) files that have been registered as embedded resources.

適用対象

こちらもご覧ください