Export (0) Print
Expand All
Expand Minimize

PipelineComponent.RegisterEvents Method

When you are developing a custom data flow component, you override this method to create custom events.

Namespace:  Microsoft.SqlServer.Dts.Pipeline
Assembly:  Microsoft.SqlServer.PipelineHost (in Microsoft.SqlServer.PipelineHost.dll)

public virtual void RegisterEvents()

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.

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);

}
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft