Design-time Methods of a Data Flow Component
Applies To: SQL Server 2016 Preview
Before execution, the data flow task is said to be in a design-time state, as it undergoes incremental changes. Changes may include the addition or removal of components, the addition or removal of the path objects that connect components, and changes to the metadata of the components. When metadata changes occur, the component can monitor and react to the changes. For example, a component can disallow certain changes or make additional changes in response to a change. At design time, the designer interacts with a component through the design-time IDTSDesigntimeComponent100 interface.
The design-time interface of a component is described by the IDTSDesigntimeComponent100 interface. Although you do not explicitly implement this interface, a familiarity with the methods defined in this interface will help you understand which methods of the PipelineComponent base class correspond to the design-time instance of a component.
When a component is loaded in the SQL Server Data Tools (SSDT), the design-time instance of the component is instantiated and the methods of the IDTSDesigntimeComponent100 interface are called as the component is edited. The implementation of the base class lets you override only those methods that your component requires. In many cases, you may override these methods to prevent inappropriate edits to a component. For example, to prevent users from adding an output to a component, override the InsertOutput method. Otherwise, when the implementation of this method by the base class is called, it adds an output to the component.
Regardless of the purpose or functionality of your component, you should override the ProvideComponentProperties, Validate, and ReinitializeMetaData methods. For more information about Validate and ReinitializeMetaData, see Validating a Data Flow Component.
The initialization of a component occurs in the ProvideComponentProperties method. This method is called by SSIS Designer when a component is added to the data flow task, and is similar to a class constructor. Component developers should create and initialize their inputs, outputs, and custom properties during this method call. The ProvideComponentProperties method differs from a constructor because it is not called every time that the design-time instance or run-time instance of the component is instantiated.
The base class implementation of the method adds an input and an output to the component and assigns the ID of the input to the SynchronousInputID property. However, in SQL Server, the input and output objects added by the base class are not named. Packages that contain a component with input or output objects whose Name property is not set will not successfully load. Therefore, when you use the base implementation, you must assign values explicitly to the Name property of the default input and output.
The call to the ProvideComponentProperties method is where component developers should add custom properties (IDTSCustomProperty100) to the component. Custom properties do not have a data type property. The data type of a custom property is set by the data type of the value that you assign to its Value property. However, after you have assigned an initial value to the custom property, you cannot assign a value with a different data type.
The IDTSCustomProperty100 interface has limited support for property values of type Object. The only object that you can store as the value of a custom property is an array of simple types such as strings or integers.
You can indicate that your custom property supports property expressions by setting the value of its ExpressionType property to CPET_NOTIFY from the DTSCustomPropertyExpressionType enumeration, as shown in the following example. You do not have to add any code to handle or to validate the property expression entered by the user. You can set a default value for the property, validate its value, and read and use its value normally.
IDTSCustomProperty100 myCustomProperty; ... myCustomProperty.ExpressionType = DTSCustomPropertyExpressionType.CPET_NOTIFY;
You can limit users to selecting a custom property value from an enumeration by using the TypeConverter property, as shown in the following example, which assumes that you have defined a public enumeration named MyValidValues.
IDTSCustomProperty100 customProperty = outputColumn.CustomPropertyCollection.New(); customProperty.Name = "My Custom Property"; // This line associates the type with the custom property. customProperty.TypeConverter = typeof(MyValidValues).AssemblyQualifiedName; // Now you can use the enumeration values directly. customProperty.Value = MyValidValues.ValueOne;
For more information, see "Generalized Type Conversion" and "Implementing a Type Converter" in the MSDN Library.
You can specify a custom editor dialog box for the value of your custom property by using the UITypeEditor property, as shown in the following example. First, you must create a custom type editor that inherits from System.Drawing.Design.UITypeEditor, if you cannot locate an existing UI type editor class that fits your needs.
Next, specify this class as the value of the UITypeEditor property of your custom property.
IDTSCustomProperty100 customProperty = outputColumn.CustomPropertyCollection.New(); customProperty.Name = "My Custom Property"; // This line associates the editor with the custom property. customProperty.UITypeEditor = typeof(MyCustomTypeEditor).AssemblyQualifiedName;
For more information, see "Implementing a UI Type Editor" in the MSDN Library.