PipelineComponent.RegisterEvents メソッド

定義

カスタムデータフローコンポーネントを開発する際には、このメソッドをオーバーライドしてカスタムイベントを作成します。

public:
 virtual void RegisterEvents();
public virtual void RegisterEvents();
abstract member RegisterEvents : unit -> unit
override this.RegisterEvents : unit -> unit
Public Overridable Sub RegisterEvents ()

以下の例は、このメソッドを上書きし、 EventInfos コレクションを使ってカスタムイベントを作成するコンポーネントを示しています。

public override void RegisterEvents()  
{  
string[] parameters = new string[1]{"Parameter1"};  
ushort[] types = new ushort[1]{DtsConvert.VarTypeFromTypeCode(TypeCode.String)};  
string[] descriptions = new string [1]{"The first parameter."};  

EventInfos.Add("OnPreExecute", "Fires when the PreExecute method runs.", false, ref parameters, ref types, ref descriptions);  

}  
Public Overrides Sub RegisterEvents()   
 Dim parameters As String() = New String(1) {"Parameter1"}   
 Dim types As System.UInt16() = New System.UInt16(1) {DtsConvert.VarTypeFromTypeCode(TypeCode.String)}   
 Dim descriptions As String() = New String(1) {"The first parameter."}   
 EventInfos.Add("OnPreExecute", "Fires when the PreExecute method runs.", False, parameters, types, descriptions)   
End Sub  

注釈

この方法はカスタムイベントを作成するコンポーネントによって上書きされます。 コンポーネントが宣言したカスタムイベントはパッケージのXMLに永続化されないため、このメソッドはコンポーネントがデザイナーにロードされる際、また実行開始時に呼び出されます。

詳細については、「Data Flow Componentにおけるイベントの提出と定義」をご覧ください。

適用対象