IDtsComponentUI Schnittstelle

Referenz

Definition

Namespace:: Microsoft.SqlServer.Dts.Pipeline.Design

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

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Wichtig

Diese API ist nicht CLS-kompatibel.

Definiert die Vom SSIS-Designer aufgerufenen Methoden für die Benutzeroberfläche einer Datenflusskomponente.

public interface class IDtsComponentUI

[System.CLSCompliant(false)]
public interface IDtsComponentUI

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

Public Interface IDtsComponentUI

Attribute: CLSCompliantAttribute

Beispiele

Im folgenden Codebeispiel wird eine Klasse veranschaulicht, die die <xref:Microsoft.SqlServer.Dts.Pipeline.Design.IdtsComponentUI> Schnittstelle implementiert. Weitere Informationen und das vollständige Beispiel finden Sie unter Entwickeln einer Benutzeroberfläche für eine Datenfluss Komponente.

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

Hinweise

Komponentenentwickler können eine Benutzeroberfläche für eine Datenflusskomponente bereitstellen, indem sie einen Typ angeben und diese Schnittstelle in der UITypeName Eigenschaft des DtsPipelineComponentAttribute Attributs implementieren. Der Designer ruft die Methoden dieser Schnittstelle auf, wenn die Komponente im SSIS-Designer hinzugefügt, gelöscht und bearbeitet wird.

Methoden

Delete(IWin32Window)	Wird aufgerufen, wenn die Komponente von der SSIS-Designer-Oberfläche gelöscht wird.
Edit(IWin32Window, Variables, Connections)	Wird aufgerufen, wenn eine Komponente bearbeitet wird.
Help(IWin32Window)	[Zur künftigen Verwendung reserviert.]
Initialize(IDTSComponentMetaData100, IServiceProvider)	Wird aufgerufen, um die Benutzeroberfläche der Komponente zu initialisieren.
New(IWin32Window)	Wird aufgerufen, wenn einem Datenflusstask anfänglich eine Komponente hinzugefügt wird.

Gilt für:

Freigeben über