IDtsComponentUI.New Method (IWin32Window)

Article
07/16/2015

Applies To: SQL Server 2016 Preview

Called when a component is initially added to a Data Flow task.

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

Syntax

void New(
    IWin32Window parentWindow
)

void New(
    IWin32Window^ parentWindow
)

abstract New : 
        parentWindow:IWin32Window -> unit

Sub New (
    parentWindow As IWin32Window
)

Parameters

parentWindow
Type: System.Windows.Forms.IWin32Window

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.

Examples

Legacy Code 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 IDTSComponentMetadata100 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