カスタム タスク用ユーザー インターフェイスの開発

DtsTask 属性

タスク クラス コードに含まれている DtsTaskAttribute 属性により、タスクはユーザー インターフェイスと関連付けられます。SSIS デザイナでは、タスクをデザイナに表示する方法を判別するために、属性のプロパティが使用されます。これらのプロパティには、表示する名前やアイコン (存在する場合) が含まれます。

次の表は、DtsTaskAttribute 属性のプロパティを示しています。

次のコード例は、DtsTaskAttribute を示します。この例でわかるように、この属性はクラス定義よりも前にコード化されています。

using System;
using Microsoft.SqlServer.Dts.Runtime;
namespace Microsoft.SSIS.Samples
{
  [DtsTask
  (
   DisplayName = "MyTask",
   IconResource = "MyTask.MyTaskIcon.ico",
   UITypeName = "My Custom Task," +
   "Version=1.0.0.0," +
   "Culture = Neutral," +
   "PublicKeyToken = 12345abc6789de01",
   TaskType = "PackageMaintenance",
   TaskContact = "MyTask; company name; any other information",
   RequiredProductLevel = DTSProductLevel.None
   )]
  public class MyTask : Task
  {
    // Your code here.
  }
}

Imports System
Imports Microsoft.SqlServer.Dts.Runtime

<DtsTask(DisplayName:="MyTask", _
 IconResource:="MyTask.MyTaskIcon.ico", _
 UITypeName:="My Custom Task," & _
 "Version=1.0.0.0,Culture=Neutral," & _
 "PublicKeyToken=12345abc6789de01", _
 TaskType:="PackageMaintenance", _
 TaskContact:="MyTask; company name; any other information", _
 RequiredProductLevel:=DTSProductLevel.None)> _
Public Class MyTask
  Inherits Task

  ' Your code here.

End Class 'MyTask

SSIS デザイナはこの属性の UITypeName プロパティを参照して、グローバル アセンブリ キャッシュ (GAC) からアセンブリを探し、読み込んでデザイナで使用します。このプロパティには、アセンブリ名、タイプ名、バージョン、カルチャ、および公開キー トークンが含まれています。

アセンブリが見つかると、SSIS デザイナは属性内の他のプロパティを使用し、タスクの名前、アイコン、説明など、タスクに関する追加情報を SSIS デザイナに表示します。

DisplayName、Description、および IconResource プロパティは、ユーザーに対してタスクをどのように表示するかを指定します。IconResource プロパティには、ユーザー インターフェイス アセンブリに埋め込まれたアイコンのリソース ID が含まれます。デザイナはこの ID を基にしてアセンブリからアイコン リソースを読み込み、タスクがパッケージに追加されたとき、ツールボックスやデザイナ画面で、タスク名の隣にアイコンを表示します。タスクがアイコン リソースを提供しない場合、デザイナはタスク用に既定のアイコンを使用します。

IDTSTaskUI インターフェイス

IDtsTaskUI インターフェイスでは、SSIS デザイナが呼び出し、タスクに関連付けられたユーザー インターフェイスを初期化して表示するための、一連のメソッドやプロパティが定義されます。タスクのユーザー インターフェイスが起動されると、デザイナは Initialize メソッドを呼び出します。このメソッドは、ユーザーが記述した際にタスク ユーザー インターフェイスに実装されたものです。次に、タスクの TaskHost コレクション、およびパッケージの Connections コレクションを、パラメータとして渡します。このコレクションはローカルに保存され、後で GetView メソッド内で使用されます。

デザイナは GetView メソッドを呼び出して、SSIS デザイナで表示するウィンドウを要求します。タスクは、タスクのユーザー インターフェイスを含むウィンドウのインスタンスを作成し、ユーザー インターフェイスをデザイナに返して表示させます。通常、オーバーロードされたコンストラクタを介して、TaskHost オブジェクトおよび Connections オブジェクトがウィンドウに渡されるため、これを使用してタスクを構成できます。

SSIS デザイナはタスク ユーザー インターフェイスの GetView メソッドを呼び出して、タスク用のユーザー インターフェイスを表示します。タスク ユーザー インターフェイスはこのメソッドから Windows フォームを返し、SSIS デザイナは、このフォームをモーダル ダイアログ ボックスとして表示します。フォームを閉じると、SSIS デザイナはフォームの DialogResult プロパティの値を確認し、タスクが変更されたかどうか、およびその変更を保存する必要があるかどうかを判断します。DialogResult プロパティの値が OK の場合、SSIS デザイナはタスクの持続メソッドを呼び出して変更を保存します。それ以外の場合は、変更は破棄されます。

次のコード例は、IDtsTaskUI インターフェイスを実装します。ここでは、SampleTaskForm という名前の Windows フォーム クラスが存在するものと想定しています。

using System;
using System.Windows.Forms;
using Microsoft.SqlServer.Dts.Runtime;
using Microsoft.SqlServer.Dts.Runtime.Design;

namespace Sample
{
   public class HelloWorldTaskUI : IDtsTaskUI
   {
      TaskHost   taskHost;
      Connections connections;
      public void Initialize(TaskHost taskHost, IServiceProvider serviceProvider)
      {
         this.taskHost = taskHost;
         IDtsConnectionService cs = serviceProvider.GetService
         ( typeof( IDtsConnectionService ) ) as   IDtsConnectionService; 
         this.connections = cs.GetConnections();
      }
      public ContainerControl GetView()
      {
        return new HelloWorldTaskForm(this.taskHost, this.connections);
      }
     public void Delete(IWin32Window parentWindow)
     {
     }
     public void New(IWin32Window parentWindow)
     {
     }
   }
}

Imports System
Imports Microsoft.SqlServer.Dts.Runtime
Imports Microsoft.SqlServer.Dts.Runtime.Design
Imports System.Windows.Forms

Public Class HelloWorldTaskUI
  Implements IDtsTaskUI

  Dim taskHost As TaskHost
  Dim connections As Connections

  Public Sub Initialize(ByVal taskHost As TaskHost, ByVal serviceProvider As IServiceProvider) _
    Implements IDtsTaskUI.Initialize

    Dim cs As IDtsConnectionService

    Me.taskHost = taskHost
    cs = DirectCast(serviceProvider.GetService(GetType(IDtsConnectionService)), IDtsConnectionService)
    Me.connections = cs.GetConnections()

  End Sub

  Public Function GetView() As ContainerControl _
    Implements IDtsTaskUI.GetView

    Return New HelloWorldTaskForm(Me.taskHost, Me.connections)

  End Function

  Public Sub Delete(ByVal parentWindow As IWin32Window) _
    Implements IDtsTaskUI.Delete

  End Sub

  Public Sub [New](ByVal parentWindow As IWin32Window) _
    Implements IDtsTaskUI.[New]

  End Sub

End Class

関連項目

概念