IDtsComponentUI Interface

Référence

Définition

Espace de noms:: Microsoft.SqlServer.Dts.Pipeline.Design

Assembly:: Microsoft.SqlServer.Dts.Design.dll

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Important

Cette API n’est pas conforme CLS.

Définit les méthodes appelées par le concepteur SSIS pour l’interface utilisateur d’un composant de flux de données.

public interface class IDtsComponentUI

[System.CLSCompliant(false)]
public interface IDtsComponentUI

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

Public Interface IDtsComponentUI

Attributs: CLSCompliantAttribute

Exemples

L’exemple de code suivant illustre une classe qui implémente l’interface <xref:Microsoft.SqlServer.Dts.Pipeline.Design.IdtsComponentUI> . Pour plus d’informations et l’exemple complet, consultez Développement d’une interface utilisateur pour un composant 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

Remarques

Les développeurs de composants peuvent fournir une interface utilisateur pour un composant de flux de données en spécifiant un type et en implémentant cette interface dans la UITypeName propriété de l’attribut DtsPipelineComponentAttribute . Le concepteur appelle les méthodes de cette interface lorsque le composant est ajouté, supprimé et modifié à l’intérieur du concepteur SSIS.

Méthodes

Delete(IWin32Window)	Appelé lorsque le composant est supprimé de l’aire du concepteur SSIS.
Edit(IWin32Window, Variables, Connections)	Appelé lorsqu'un composant est modifié.
Help(IWin32Window)	Réservée pour un usage ultérieur.
Initialize(IDTSComponentMetaData100, IServiceProvider)	Appelé pour initialiser l'interface utilisateur du composant.
New(IWin32Window)	Appelé lorsqu'un composant est ajouté initialement à une tâche de flux de données.

S’applique à

Partager via