IDtsComponentUI.Initialize Method

Article
12/03/2008

Called to initialize the user interface of the component. This method is not CLS-compliant.

Namespace: Microsoft.SqlServer.Dts.Pipeline.Design
Assembly: Microsoft.SqlServer.Dts.Design (in microsoft.sqlserver.dts.design.dll)

Syntax

'Declaration
Sub Initialize ( _
    dtsComponentMetadata As IDTSComponentMetaData90, _
    serviceProvider As IServiceProvider _
)

void Initialize (
    IDTSComponentMetaData90 dtsComponentMetadata,
    IServiceProvider serviceProvider
)

void Initialize (
    IDTSComponentMetaData90^ dtsComponentMetadata, 
    IServiceProvider^ serviceProvider
)

void Initialize (
    IDTSComponentMetaData90 dtsComponentMetadata, 
    IServiceProvider serviceProvider
)

function Initialize (
    dtsComponentMetadata : IDTSComponentMetaData90, 
    serviceProvider : IServiceProvider
)

Parameters

dtsComponentMetadata
The IDTSComponentMetaData90 of the component.

serviceProvider
The IServiceProvider interface provided by the SSIS designer.

Remarks

Updated text:5 December 2005

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 list shows the available services in the SSIS Designer.

Service	Description
IDtsClipboardService	Used to determine whether the component was generated as part of a copy/paste or cut/paste operation.
IDtsConnectionService	Used to access existing and create new connections in the package.
IErrorCollectionService	Used to capture events from data flow components when you need to capture all the errors and warnings raised by the component instead of receiving only the last error or warning.
IDtsVariableService	Used to access existing or to create new variables in the package.

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

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms