Share via

IDtsComponentUI.Initialize Method

  • Article

Called to initialize the user interface of the component.

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

Syntax

'Declaration
Sub Initialize ( _
    dtsComponentMetadata As IDTSComponentMetaData100, _
    serviceProvider As IServiceProvider _
)
'Usage
Dim instance As IDtsComponentUI 
Dim dtsComponentMetadata As IDTSComponentMetaData100 
Dim serviceProvider As IServiceProvider

instance.Initialize(dtsComponentMetadata, _
    serviceProvider)

void Initialize(
    IDTSComponentMetaData100 dtsComponentMetadata,
    IServiceProvider serviceProvider
)

void Initialize(
    IDTSComponentMetaData100^ dtsComponentMetadata, 
    IServiceProvider^ serviceProvider
)

abstract Initialize : 
        dtsComponentMetadata:IDTSComponentMetaData100 * 
        serviceProvider:IServiceProvider -> unit

function Initialize(
    dtsComponentMetadata : IDTSComponentMetaData100, 
    serviceProvider : IServiceProvider
)

Parameters

Remarks

This method is called when a component is initially added to the SSIS Designer surface, and prior to the New method. It is also called when a component is edited, but prior to the Edit method.

Cache the object reference received in the dtsComponentMetadata parameter and use it in the Edit method to make changes to your component as the user interacts with your user interface. Typically, you must also pass this object reference to any supporting classes that you may create, such as a form class, to implement editing functionality for a component.

The serviceProvider parameter provides access to the services of the SSIS Designer. The following table shows the available services in the SSIS Designer.

Service

Description

IDtsClipboardService

Determines whether the component was generated as part of a copy/paste or cut/paste operation.

IDtsConnectionService

Accesses existing and creates new connections in the package.

IDtsDesignerUtilitiesService

Provides methods that let Integration Services developers invoke the Expression Builder dialog box programmatically.

IDtsPipelineEnvironmentService

Gives data flow components access to the parent Data Flow task and its TaskHost container.

IDtsVariableService

Accesses existing or creates new variables in the package.

IErrorCollectionService

Captures events from data flow components when you have to capture all the errors and warnings raised by the component instead of receiving only the last error or warning.

These services provide component developers the ability to access and create objects in the package in which the component is loaded.

See Also

Reference

IDtsComponentUI Interface

Microsoft.SqlServer.Dts.Pipeline.Design Namespace