IDtsComponentUI Interface

Definição

Namespace:

Microsoft.SqlServer.Dts.Pipeline.Design

Assembly:

Microsoft.SqlServer.Dts.Design.dll

Importante

Esta API não está em conformidade com CLS.

Define os métodos chamados pelo Designer do SSIS para a interface do usuário de um componente de fluxo de dados.

public interface class IDtsComponentUI

[System.CLSCompliant(false)]
public interface IDtsComponentUI

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

Public Interface IDtsComponentUI

Atributos

CLSCompliantAttribute

Exemplos

O exemplo de código a seguir demonstra uma classe que implementa a <xref:Microsoft.SqlServer.Dts.Pipeline.Design.IdtsComponentUI> interface . Para obter mais informações e o exemplo completo, consulte Desenvolvendo uma interface do usuário para um componente Fluxo de Dados.

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  

Comentários

Os desenvolvedores de componentes podem fornecer uma interface do usuário para um componente de fluxo de dados especificando um Tipo e implementando essa interface na UITypeName propriedade do DtsPipelineComponentAttribute atributo. O designer chama os métodos dessa interface quando o componente é adicionado, excluído e editado dentro do Designer do SSIS.

Métodos

Delete(IWin32Window)	Chamado quando o componente é excluído da superfície do Designer do SSIS.
Edit(IWin32Window, Variables, Connections)	Chamado quando um componente é editado.
Help(IWin32Window)	[Reservado para uso futuro.]
Initialize(IDTSComponentMetaData100, IServiceProvider)	Chamado para inicializar a interface do usuário do componente.
New(IWin32Window)	Chamado quando um componente é adicionado inicialmente a uma tarefa de Fluxo de Dados.