Developing a User Interface for a Custom Task

Atrybut DtsTask

The DtsTaskAttribute atrybut is included in the task class code to associate a task with its user interfejs. The SSIS Designer uses the properties of the atrybut to determine how to display the task in the designer. Właściwości tych należą: nazwę i ikonę, jeśli istnieje.

W poniższej tabela opisano właściwości DtsTaskAttribute atrybut.

Następujący kod przykładzie DtsTaskAttribute jak będzie wyglądał kodowane powyżej definicji klasy.

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

The SSIS Designer uses the UITypeName() właściwość of the atrybut that includes the wirtualny plik dziennika name, type name, wersja, culture, and public klucz token, to locate the wirtualny plik dziennika in the Global wirtualny plik dziennika Cache (GAC) and load it for use by the designer.

Po, wirtualny plik dziennika SSIS Projektant używa innych właściwości w atrybucie do wyświetlania dodatkowych informacji o zadaniu w SSIS Projektant, takie jak nazwisko, ikona i opis zadania.

The DisplayName(), Description(), and IconResource() properties specify how the task is presented to the user.The IconResource() właściwość contains the zasób ID of the icon embedded in the user interfejs wirtualny plik dziennika. Projektant ładuje zasób ikona przy użyciu IDENTYFIKATORA z wirtualny plik dziennika i wyświetla je obok nazwy zadania w przyborniku, a na powierzchni projektanta, gdy zadanie zostanie dodany do pakiet.Jeśli zadanie nie zawiera zasób ikony, Projektant używa domyślnej ikony dla tego zadania.

Interfejs IDTSTaskUI

The IDtsTaskUI interfejs defines the kolekcja of methods and properties called by SSIS Designer to initialize and display the user interfejs associated with the task. Wywołania interfejsu użytkownika dla zadania, wywołania konstruktora Initialize(TaskHost, IServiceProvider) metoda implementowane przez zadań interfejs użytkownika, gdy został on napisany, a następnie zawiera TaskHost i Connections Kolekcje zadania i pakiet, odpowiednio jako parametry. Te kolekcje są przechowywane lokalnie i później w używać GetView() Metoda.

Wywołania konstruktora GetView() Metoda żądania wyświetlanych w oknie SSIS Projektant. Zadanie tworzy wystąpienie okna zawiera interfejsu użytkownika dla zadania, a następnie zwraca interfejs użytkownika do projektanta do wyświetlenia.Zazwyczaj TaskHost i Connections obiekty znajdują się w oknie za pomocą przeciążone konstruktora tak, aby mogły być używane do konfigurowania zadania.

The SSIS Designer calls the GetView() metoda of the task UI to display the user interfejs for the task. Interfejs użytkownika zadania zwraca formularzy systemu Windows z tej metoda, a SSIS Projektant wyświetlanie tego formularza jako modalnego okna dialogowego. Po zamknięciu formularza SSIS Projektant sprawdza, czy wartość DialogResult Właściwość formularza w celu ustalenia, czy zadania została zmodyfikowana i zmiany te mają być zapisywane. Jeśli wartość DialogResult Właściwość jest OK, SSIS Projektant wywołuje metody trwałość zadania, aby zapisać zmiany; w przeciwnym razie zmiany zostaną odrzucone.

Następujący kod przykładowy implementuje IDtsTaskUI interfejs i zakłada się istnienie klasę formularzy systemu Windows o nazwie SampleTaskForm.

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

See Also

Concepts