• Article

CManagedComponentWrapper Interface

Configures the properties and column collections of a component.

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

Syntax

'Declaration
<GuidAttribute("B13097E5-4465-4A9C-BB74-FFC8F8E30760")> _
Public Interface CManagedComponentWrapper _
    Inherits IDTSDesigntimeComponent100
'Usage
Dim instance As CManagedComponentWrapper

[GuidAttribute("B13097E5-4465-4A9C-BB74-FFC8F8E30760")]
public interface CManagedComponentWrapper : IDTSDesigntimeComponent100

[GuidAttribute(L"B13097E5-4465-4A9C-BB74-FFC8F8E30760")]
public interface class CManagedComponentWrapper : IDTSDesigntimeComponent100

[<GuidAttribute("B13097E5-4465-4A9C-BB74-FFC8F8E30760")>]
type CManagedComponentWrapper =  
    interface
        interface IDTSDesigntimeComponent100
    end

public interface CManagedComponentWrapper extends IDTSDesigntimeComponent100

The CManagedComponentWrapper type exposes the following members.

Methods

  Name Description
Public method AcquireConnections Establishes a connection to a connection manager. (Inherited from IDTSDesigntimeComponent100.)
Public method DeleteExternalMetadataColumn Deletes the external metadata column at the specified index from the collection of external metadata columns. (Inherited from IDTSDesigntimeComponent100.)
Public method DeleteInput Deletes an IDTSInput100 object from the IDTSInputCollection100 collection. (Inherited from IDTSDesigntimeComponent100.)
Public method DeleteOutput Deletes an IDTSOutput100 object from the IDTSOutputCollection100 collection. (Inherited from IDTSDesigntimeComponent100.)
Public method DeleteOutputColumn Deletes an IDTSOutputColumn100 object from the IDTSOutputColumnCollection100 collection. (Inherited from IDTSDesigntimeComponent100.)
Public method DescribeRedirectedErrorCode Returns the description of the specified error code. (Inherited from IDTSDesigntimeComponent100.)
Public method GetEnumerationCollection Returns the IDTSFriendlyEnumCollection100 of a component. (Inherited from IDTSDesigntimeComponent100.)
Public method InsertExternalMetadataColumnAt Inserts a new external metadata column into the collection of external metadata columns at the specified index. (Inherited from IDTSDesigntimeComponent100.)
Public method InsertInput Adds an IDTSInput100 object to the IDTSInputCollection100. (Inherited from IDTSDesigntimeComponent100.)
Public method InsertOutput Adds a new IDTSOutput100 object. (Inherited from IDTSDesigntimeComponent100.)
Public method InsertOutputColumnAt Creates a new IDTSOutputColumn100 object and inserts it into the IDTSOutputColumnCollection100. (Inherited from IDTSDesigntimeComponent100.)
Public method MapInputColumn Establishes a relationship between an input column and a corresponding external metadata column. (Inherited from IDTSDesigntimeComponent100.)
Public method MapOutputColumn Establishes a relationship between an output column and a corresponding external metadata column. (Inherited from IDTSDesigntimeComponent100.)
Public method OnDeletingInputColumn Called when deleting an IDTSInputColumn100 object from the IDTSInputColumnCollection100. (Inherited from IDTSDesigntimeComponent100.)
Public method OnInputPathAttached Called when an IDTSInput100 object is connected to another component through the IDTSPath100 interface. (Inherited from IDTSDesigntimeComponent100.)
Public method OnInputPathDetached Called when an IDTSPath100 object that contains the specified IDTSInput100 object is deleted. (Inherited from IDTSDesigntimeComponent100.)
Public method OnOutputPathAttached Called when an IDTSOutput100 object of the component is attached to a downstream component. (Inherited from IDTSDesigntimeComponent100.)
Public method ProvideComponentProperties Initializes the ComponentMetaData of the component when a component is first added to the data flow task. (Inherited from IDTSDesigntimeComponent100.)
Public method ReinitializeMetaData Fixes any errors identified during design-time validation that result in the component returning VS_NEEDSNEWMETADATA. (Inherited from IDTSDesigntimeComponent100.)
Public method ReleaseConnections Frees the connections established during AcquireConnections at either design time or run time. (Inherited from IDTSDesigntimeComponent100.)
Public method SetComponentProperty Assigns a value to an IDTSCustomProperty100 of a component. (Inherited from IDTSDesigntimeComponent100.)
Public method SetExternalMetadataColumnDataTypeProperties Sets the data type properties of the specified external metadata column. (Inherited from IDTSDesigntimeComponent100.)
Public method SetExternalMetadataColumnProperty Sets an individual property of an external metadata column. (Inherited from IDTSDesigntimeComponent100.)
Public method SetInputColumnProperty Assigns a value to the IDTSCustomProperty100 of an IDTSInputColumn100 object. (Inherited from IDTSDesigntimeComponent100.)
Public method SetInputProperty Assigns a value to the IDTSCustomProperty100 of an IDTSInput100 object. (Inherited from IDTSDesigntimeComponent100.)
Public method SetOutputColumnDataTypeProperties Sets the data type properties of an IDTSOutputColumn100 object. (Inherited from IDTSDesigntimeComponent100.)
Public method SetOutputColumnProperty Sets the value of an IDTSCustomProperty100 for an IDTSOutputColumn100 object. (Inherited from IDTSDesigntimeComponent100.)
Public method SetOutputProperty Sets the value of an IDTSCustomProperty100 on an IDTSOutput100 object. (Inherited from IDTSDesigntimeComponent100.)
Public method SetUsageType Creates an IDTSInputColumn100 object in the IDTSInputColumnCollection100 of the component and sets the UsageType property of the column. (Inherited from IDTSDesigntimeComponent100.)
Public method Validate Verifies that the component is correctly configured. (Inherited from IDTSDesigntimeComponent100.)

Top

Remarks

The CManagedComponentWrapper represents the interface of IDTSDesigntimeComponent100 that is used in design time modification of a data flow component. CManagedComponentWrapper is used to configure the properties and column collections of a data flow component during design time. While the metadata of a component can be modified directly, this should be avoided because doing so bypasses the component's ability to validate modifications to its metadata. An instance of CManagedComponentWrapper is created by calling the Instantiate method of a component's IDTSComponentMetaData100 interface.

The methods and properties defined by the interface are visible on both the CManagedComponentWrapperClass and the IDTSDesigntimeComponent100 types.

Examples

The following code example demonstrates how to programmatically add a component to a data flow task and create an instance of the design-time interface.

using System;
using Microsoft.SqlServer.Dts.Runtime;
using Microsoft.SqlServer.Dts.Pipeline.Wrapper;

namespace Microsoft.Samples.SqlServer.Dts
{
    class CreateComponent
    {
         [STAThread]
        static void Main(string[] args)
        {
            // Create the package.
            Package p = new Package();

            // Add the data flow task to the package.
            MainPipe dataFlowTask = ((TaskHost)p.Executables.Add("SSIS.Pipeline.2")).InnerObject as MainPipe;

            if (dataFlowTask != null)
            {
                // Add a component to the data flow task.
                IDTSComponentMetaData100 metaData = dataFlowTask.ComponentMetaDataCollection.New();

                // Set the class id of the component.
                metaData.ComponentClassID = "";

                // Create an instance of the component.
                CManagedComponentWrapper wrapper = metaData.Instantiate();

                // Initialize the component by calling ProvideComponentProperties.
                wrapper.ProvideComponentProperties();
            }
        }
    }
}