IDtsComponentUI 接口

定义

命名空间:

Microsoft.SqlServer.Dts.Pipeline.Design

程序集:

Microsoft.SqlServer.Dts.Design.dll

重要

此 API 不符合 CLS。

定义 SSIS 设计器为数据流组件的用户界面调用的方法。

public interface class IDtsComponentUI

[System.CLSCompliant(false)]
public interface IDtsComponentUI

[<System.CLSCompliant(false)>]
type IDtsComponentUI = interface

Public Interface IDtsComponentUI

属性

CLSCompliantAttribute

示例

下面的代码示例演示了实现 接口的 <xref:Microsoft.SqlServer.Dts.Pipeline.Design.IdtsComponentUI> 类。 有关详细信息和完整示例，请参阅开发数据流组件的用户界面。

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  

注解

组件开发人员可以通过指定 类型并在 属性的 DtsPipelineComponentAttribute 属性中UITypeName实现此接口来为数据流组件提供用户界面。 在 SSIS 设计器中添加、删除和编辑组件时，设计器会调用此接口的方法。

方法

Delete(IWin32Window)	从 SSIS 设计器图面中删除组件时调用。
Edit(IWin32Window, Variables, Connections)	当编辑组件时调用。
Help(IWin32Window)	[保留供将来使用。]
Initialize(IDTSComponentMetaData100, IServiceProvider)	调用以初始化组件的用户界面。
New(IWin32Window)	当最初将一个组件添加到数据流任务时调用。