DtsPipelineComponentAttribute.UITypeName Property

Article
07/16/2015

Applies To: SQL Server 2016 Preview

Gets or sets the qualified name of the assembly implementing the user interface of the component.

Namespace: Microsoft.SqlServer.Dts.Pipeline
Assembly: Microsoft.SqlServer.PipelineHost (in Microsoft.SqlServer.PipelineHost.dll)

Syntax

public string UITypeName { get; set; }

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

member UITypeName : string with get, set

Public Property UITypeName As String

Property Value

Type: System.String

The fully qualified name of the type implementing the IDtsComponentUI interface.

Remarks

This optional property specifies the user interface that is displayed when the component is edited in SQL Server or 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

The type name specified in this property implements the IDtsComponentUI interface. The values of the Culture and PublicKeyToken parameters can be found by examining the properties of the user interface assembly in the global assembly cache.

Examples

Legacy Code Example

The following example shows a component that specifies an editor using this property.

using System;
using Microsoft.SqlServer.Dts.Pipeline.Design;
using Microsoft.SqlServer.Dts.Pipeline.Wrapper;
namespace DtsDocumentation
{
   [DtsPipelineComponent(DisplayName="MyComponent",UITypeName="MyNamespace.MyComponentUIClassName,MyAssemblyName,Version=1.0.0.0,Culture=neutral,PublicKeyToken=")]
   public class MyComponent : PipelineComponent
   {
   }
}

[Visual Basic]
Imports System 
Imports Microsoft.SqlServer.Dts.Pipeline.Design 
Imports Microsoft.SqlServer.Dts.Pipeline.Wrapper 
Namespace DtsDocumentation 

 <DtsPipelineComponent(DisplayName="MyComponent", UITypeName="MyNamespace.MyComponentUIClassName,MyAssemblyName,Version=1.0.0.0,Culture=neutral,PublicKeyToken=")> _ 
 Public Class MyComponent 
 Inherits PipelineComponent 
 End Class 
End Namespace