DtsTaskAttribute.UITypeName Property

Reference

Definition

Namespace:: Microsoft.SqlServer.Dts.Runtime

Assembly:: Microsoft.SqlServer.ManagedDTS.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

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

public string UITypeName { get; set; }

member this.UITypeName : string with get, set

Public Property UITypeName As String

Property Value

String

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

Examples

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.

Remarks

This optional property specifies the user interface that is displayed when the task is edited in the SQL Server Data Tools (SSDT) .

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

Applies to

Product	Versions
SQL Server .NET SDK	2016, 2017, 2019

Share via