IDtsComponentUI Interfaz

Definición

Espacio de nombres:

Microsoft.SqlServer.Dts.Pipeline.Design

Ensamblado:

Microsoft.SqlServer.Dts.Design.dll

Importante

Esta API no es conforme a CLS.

Define los métodos llamados por el Diseñador de SSIS para la interfaz de usuario de un componente de flujo de datos.

public interface class IDtsComponentUI

[System.CLSCompliant(false)]
public interface IDtsComponentUI

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

Public Interface IDtsComponentUI

Atributos

CLSCompliantAttribute

Ejemplos

En el ejemplo de código siguiente se muestra una clase que implementa la <xref:Microsoft.SqlServer.Dts.Pipeline.Design.IdtsComponentUI> interfaz . Para obtener más información y el ejemplo completo, consulte Desarrollo de una interfaz de usuario para un componente de Data Flow.

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  

Comentarios

Los desarrolladores de componentes pueden proporcionar una interfaz de usuario para un componente de flujo de datos especificando un tipo e implementando esta interfaz en la UITypeName propiedad del DtsPipelineComponentAttribute atributo . El diseñador llama a los métodos de esta interfaz cuando se agrega, elimina y edita el componente dentro del Diseñador de SSIS.

Métodos

Delete(IWin32Window)	Se llama cuando el componente se elimina de la superficie del Diseñador de SSIS.
Edit(IWin32Window, Variables, Connections)	Recibe una llamada al editar un componente.
Help(IWin32Window)	[Reservado para uso futuro.]
Initialize(IDTSComponentMetaData100, IServiceProvider)	Recibe una llamada para inicializar la interfaz de usuario del componente.
New(IWin32Window)	Recibe una llamada al agregar inicialmente un componente a una tarea Flujo de datos.