IDtsComponentUI.New Method

Article
12/03/2008

Called when a component is initially added to a Data Flow task. 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 New ( _
    parentWindow As IWin32Window _
)

void New (
    IWin32Window parentWindow
)

void New (
    IWin32Window^ parentWindow
)

void New (
    IWin32Window parentWindow
)

function New (
    parentWindow : IWin32Window
)

Parameters

parentWindow
The System.Windows.Forms.IWin32Window of SSIS Designer.

Remarks

Use this method to respond when your component is added to the package. You may choose to show an initial configuration dialog box or wizard to help guide users in configuring your component. The ScriptComponent, for example, displays a dialog box asking the user to specify the type of component to create when it is initially added to the data flow task.

When displaying a window in the SSIS Designer, use the parentWindow parameter to ensure the window is shown within the bounds of the designer.

Example

The following example shows a sample implementation of the New method showing a dialog in response to its component being added to the package. The metadata for the component is cached during the Initialize method.

public void New(IWin32Window parentWindow)
{
//    The constructor for this windows form, has been modified 
//    to accept an IDTSComponentMetadata90 parameter.
    MyWizard wiz = new MyWizard(this.md);
    nd.ShowDialog(parentWindow);
}

Public Sub New(ByVal parentWindow As IWin32Window) 
 Dim wiz As MyWizard = New MyWizard(Me.md) 
 nd.ShowDialog(parentWindow) 
End Sub

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