DtsPipelineComponentAttribute.UITypeName Property

Reference

Definition

Namespace:: Microsoft.SqlServer.Dts.Pipeline

Assembly:: Microsoft.SqlServer.PipelineHost.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.

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

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 fully qualified name of the type implementing the IDtsComponentUI interface.

Examples

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

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.

Applies to

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

Share via