次の方法で共有

IDtsComponentUI インターフェイス

  • [アーティクル]

データ フロー コンポーネントのユーザー インターフェイスのために SSIS デザイナーから呼び出されるメソッドを定義します。

この API は、CLS に準拠していません。 

名前空間:  Microsoft.SqlServer.Dts.Pipeline.Design
アセンブリ:  Microsoft.SqlServer.Dts.Design (Microsoft.SqlServer.Dts.Design.dll)

構文

'宣言
<CLSCompliantAttribute(False)> _
Public Interface IDtsComponentUI
'使用
Dim instance As IDtsComponentUI

[CLSCompliantAttribute(false)]
public interface IDtsComponentUI

[CLSCompliantAttribute(false)]
public interface class IDtsComponentUI

[<CLSCompliantAttribute(false)>]
type IDtsComponentUI =  interface end

public interface IDtsComponentUI

IDtsComponentUI 型は、以下のメンバーを公開しています。

メソッド

  名前 説明
パブリック メソッド Delete SSIS デザイナー画面からコンポーネントが削除されると呼び出されます。
パブリック メソッド Edit コンポーネントの編集時に呼び出されます。
パブリック メソッド Help [将来の使用のために予約されています。]
パブリック メソッド Initialize コンポーネントのユーザー インターフェイスの初期化のために呼び出されます。
パブリック メソッド New コンポーネントが最初にデータ フロー タスクに追加されるときに呼び出されます。

先頭に戻る

説明

コンポーネント開発者は、型を指定し、DtsPipelineComponentAttribute 属性の UITypeName プロパティにこのインターフェイスを実装することによって、データ フロー コンポーネントに対してユーザー インターフェイスを提供できます。 SSIS デザイナー内でコンポーネントが追加、削除、編集されると、デザイナーによってこのインターフェイスのメソッドが呼び出されます。

使用例

次のコード サンプルは、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

関連項目

参照

Microsoft.SqlServer.Dts.Pipeline.Design 名前空間