IDtsComponentUI Интерфейс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Важно!
Этот API несовместим с CLS.
Определяет методы, вызываемые конструктором служб SSIS для пользовательского интерфейса компонента потока данных.
public interface class IDtsComponentUI
[System.CLSCompliant(false)]
public interface IDtsComponentUI
[<System.CLSCompliant(false)>]
type IDtsComponentUI = interface
Public Interface IDtsComponentUI
- Атрибуты
Примеры
В следующем примере кода демонстрируется класс, реализующий <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
Комментарии
Разработчики компонентов могут предоставить пользовательский интерфейс для компонента потока данных, указав тип и реализовав этот интерфейс в UITypeName свойстве атрибута DtsPipelineComponentAttribute . Конструктор вызывает методы этого интерфейса при добавлении, удалении и изменении компонента в конструкторе служб SSIS.
Методы
Delete(IWin32Window) |
Вызывается при удалении компонента из области конструктора служб SSIS. |
Edit(IWin32Window, Variables, Connections) |
Вызывается при редактировании компонента. |
Help(IWin32Window) |
[Зарезервировано для последующего использования.] |
Initialize(IDTSComponentMetaData100, IServiceProvider) |
Вызывается при инициализации пользовательского интерфейса компонента. |
New(IWin32Window) |
Вызывается при первоначальном добавлении компонента в задачу потока данных. |