IDtsComponentUI.New(IWin32Window) Method

Reference

Definition

Namespace:: Microsoft.SqlServer.Dts.Pipeline.Design

Assembly:: Microsoft.SqlServer.Dts.Design.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 void New(System::Windows::Forms::IWin32Window ^ parentWindow);

public void New (System.Windows.Forms.IWin32Window parentWindow);

abstract member New : System.Windows.Forms.IWin32Window -> unit

Public Sub New (parentWindow As IWin32Window)

Parameters

parentWindow: IWin32Window

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

Examples

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

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.

Applies to

Share via