DtsTaskAttribute.UITypeName Property

Article
12/03/2008

Specifies the qualified name of the assembly that implements the user interface of the task.

Namespace: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in microsoft.sqlserver.manageddts.dll)

Syntax

'Declaration
Public Property UITypeName As String

public string UITypeName { get; set; }

public:
property String^ UITypeName {
    String^ get ();
    void set (String^ value);
}

/** @property */
public String get_UITypeName ()

/** @property */
public void set_UITypeName (String value)

public function get UITypeName () : String

public function set UITypeName (value : String)

Property Value

The type name of the user interface of the task object.

Remarks

Updated sample code:15 September 2007

This optional property specifies the user interface that is displayed when the task is edited in the Business Intelligence Development Studio.

The format of the property is a comma-delimited string that contains the following elements:

Type name
Assembly name
File version
Culture
Public key token

Example

The following example demonstrates the proper format of this property.

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

You find the values of the Culture and PublicKeyToken parameters by examining the properties of the user interface assembly in the global assembly cache.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms