DtsPipelineComponentAttribute.UITypeName Property

Article
12/03/2008

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

'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 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 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

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.

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

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