IDtsComponentUI IDtsComponentUI IDtsComponentUI Interface

Definition

Important

This API is not CLS-compliant.

Defines the methods called by SSIS Designer for the user interface of a data flow component.

public interface class IDtsComponentUI
[System.CLSCompliant(false)]
public interface IDtsComponentUI
Public Interface IDtsComponentUI
Attributes

Examples

The following code sample demonstrates a class that implements the <xref:Microsoft.SqlServer.Dts.Pipeline.Design.IdtsComponentUI> interface. For more information and the complete sample, see Developing a User Interface for a Data Flow Component.

using System;  
using System.Windows.Forms;  
using Microsoft.SqlServer.Dts.Runtime;  
using Microsoft.SqlServer.Dts.Pipeline.Design;  
using Microsoft.SqlServer.Dts.Pipeline.Wrapper;  
  
namespace Microsoft.Samples.SqlServer.Dts  
{  
    public class SampleComponentUI : IDtsComponentUI  
    {  
        IDTSComponentMetaData100 md;  
        IServiceProvider sp;  
  
        public void Help(System.Windows.Forms.IWin32Window parentWindow)  
        {  
        }  
        public void New(System.Windows.Forms.IWin32Window parentWindow)  
        {  
        }  
        public void Delete(System.Windows.Forms.IWin32Window parentWindow)  
        {  
        }  
        public bool Edit(System.Windows.Forms.IWin32Window parentWindow, Variables vars, Connections cons)  
        {  
            // Create the component's form, and then display it.  
            SampleComponentUIForm componentEditor = new SampleComponentUIForm(cons, vars, md);  
  
            DialogResult result  = componentEditor.ShowDialog(parentWindow);  
  
            if (result == DialogResult.OK)  
                return true;  
  
            return false;  
        }  
        public void Initialize(IDTSComponentMetaData100 dtsComponentMetadata, IServiceProvider serviceProvider)  
        {  
            // Store the component metadata.  
            this.md = dtsComponentMetadata;  
        }  
    }  
}  
Imports System   
Imports System.Windows.Forms   
Imports Microsoft.SqlServer.Dts.Runtime   
Imports Microsoft.SqlServer.Dts.Pipeline.Design   
Imports Microsoft.SqlServer.Dts.Pipeline.Wrapper   
  
Public Class SampleComponentUI   
Implements IDtsComponentUI   
 Private md As IDTSComponentMetaData100   
 Private sp As IServiceProvider   
  
 Public Sub Help(ByVal parentWindow As System.Windows.Forms.IWin32Window)   
 End Sub   
  
 Public Sub New(ByVal parentWindow As System.Windows.Forms.IWin32Window)   
 End Sub   
  
 Public Sub Delete(ByVal parentWindow As System.Windows.Forms.IWin32Window)   
 End Sub   
  
 Public Function Edit(ByVal parentWindow As System.Windows.Forms.IWin32Window, ByVal vars As Variables, ByVal cons As Connections) As Boolean   
   Dim componentEditor As SampleComponentUIForm = New SampleComponentUIForm(cons, vars, md)   
   Dim result As DialogResult = componentEditor.ShowDialog(parentWindow)   
   If result = DialogResult.OK Then   
     Return True   
   End If   
   Return False   
 End Function   
  
 Public Sub Initialize(ByVal dtsComponentMetadata As IDTSComponentMetaData100, ByVal serviceProvider As IServiceProvider)   
   Me.md = dtsComponentMetadata   
 End Sub   
End Class  

Remarks

Component developers can provide a user interface for a data flow component by specifying a Type and implementing this interface in the UITypeName property of the DtsPipelineComponentAttribute attribute. The designer calls the methods of this interface when the component is added, deleted, and edited inside the SSIS Designer.

Methods

Delete(IWin32Window) Delete(IWin32Window) Delete(IWin32Window)

Called when the component is deleted from the SSIS Designer surface.

Edit(IWin32Window, Variables, Connections) Edit(IWin32Window, Variables, Connections) Edit(IWin32Window, Variables, Connections)

Called when a component is edited.

Help(IWin32Window) Help(IWin32Window) Help(IWin32Window)

[Reserved for future use.]

Initialize(IDTSComponentMetaData100, IServiceProvider) Initialize(IDTSComponentMetaData100, IServiceProvider) Initialize(IDTSComponentMetaData100, IServiceProvider)

Called to initialize the user interface of the component.

New(IWin32Window) New(IWin32Window) New(IWin32Window)

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

Applies to