IDtsComponentUI Interface

 

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

This API is not CLS-compliant.

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

[CLSCompliantAttribute(false)]
public interface IDtsComponentUI

NameDescription
System_CAPS_pubmethodDelete(IWin32Window)

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

System_CAPS_pubmethodEdit(IWin32Window, Variables, Connections)

Called when a component is edited.

System_CAPS_pubmethodHelp(IWin32Window)

[Reserved for future use.]

System_CAPS_pubmethodInitialize(IDTSComponentMetaData100, IServiceProvider)

Called to initialize the user interface of the component.

System_CAPS_pubmethodNew(IWin32Window)

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

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.

The following code sample demonstrates a class that implements the T: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;
        }
    }
}
Return to top
Show: