PipelineComponent.RegisterEvents Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
When you are developing a custom data flow component, you override this method to create custom events.
public:
virtual void RegisterEvents();public virtual void RegisterEvents ();abstract member RegisterEvents : unit -> unit
override this.RegisterEvents : unit -> unitPublic Overridable Sub RegisterEvents ()Examples
The following example shows a component that overrides this method and creates a custom event using the EventInfos collection.
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
Remarks
This method is overridden by components that create custom events. Because the custom events declared by a component are not persisted in the package XML, this method is called as the component is loaded into the designer, and at the start of execution.
For more information, see Raising and Defining Events in a Data Flow Component.