DtsPipelineComponentAttribute Class

Article
04/26/2013

Contains design-time information about a PipelineComponent object.

Inheritance Hierarchy

System.Object
  System.Attribute
    Microsoft.SqlServer.Dts.Pipeline.Localization.DtsLocalizableAttribute
      Microsoft.SqlServer.Dts.Pipeline.DtsPipelineComponentAttribute

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

Syntax

'Declaration
<AttributeUsageAttribute(AttributeTargets.Class, Inherited := False, AllowMultiple := False)> _
Public Class DtsPipelineComponentAttribute _
    Inherits DtsLocalizableAttribute
'Usage
Dim instance As DtsPipelineComponentAttribute

[AttributeUsageAttribute(AttributeTargets.Class, Inherited = false, AllowMultiple = false)]
public class DtsPipelineComponentAttribute : DtsLocalizableAttribute

[AttributeUsageAttribute(AttributeTargets::Class, Inherited = false, AllowMultiple = false)]
public ref class DtsPipelineComponentAttribute : public DtsLocalizableAttribute

[<AttributeUsageAttribute(AttributeTargets.Class, Inherited = false, AllowMultiple = false)>]
type DtsPipelineComponentAttribute =  
    class 
        inherit DtsLocalizableAttribute 
    end

public class DtsPipelineComponentAttribute extends DtsLocalizableAttribute

The DtsPipelineComponentAttribute type exposes the following members.

Constructors

	Name	Description
	DtsPipelineComponentAttribute	Initializes a new instance of the DtsPipelineComponentAttribute class.

Top

Properties

	Name	Description
	ComponentType	Identifies a component as a source, destination, or transformation.
	CurrentVersion	Gets or sets the version of the component.
	Description	Gets or sets the description of the DtsLocalizableAttribute. (Inherited from DtsLocalizableAttribute.)
	DisplayName	Gets or sets the display name of the DtsLocalizableAttribute. (Inherited from DtsLocalizableAttribute.)
	HelpCollection	Gets or sets the help collection from which to retrieve the help.
	HelpKeyword	Gets or sets the help keyword associated with the component.
	IconResource	Gets or sets the icon used to represent the component in the toolbox.
	LocalizationType	Gets or sets the class that supplies values for the DtsLocalizableAttribute. (Inherited from DtsLocalizableAttribute.)
	NoEditor	Gets or sets a value indicating whether the Advanced Properties editor is available for the component.
	RequiredProductLevel	Gets or sets a value indicating the required SQL Server 2005 product level for the data flow component.
	SamplesTag	Gets or sets the samples tag from the component.
	ShapeProgID	Gets or sets the designer shape of the component.
	SupportsBackPressure	Identifies the component as one that supports more than one input, and implements the optional methods for handling excessive memory usage if the inputs produce data at uneven rates.
	TypeId	(Inherited from Attribute.)
	UITypeName	Gets or sets the qualified name of the assembly implementing the user interface of the component.

Top

Methods

	Name	Description
	Equals	(Inherited from Attribute.)
	Finalize	(Inherited from Object.)
	GetHashCode	(Inherited from Attribute.)
	GetType	(Inherited from Object.)
	IsDefaultAttribute	(Inherited from Attribute.)
	Match	(Inherited from Attribute.)
	MemberwiseClone	(Inherited from Object.)
	ToString	(Inherited from Object.)

Top

Explicit Interface Implementations

	Name	Description
	_Attribute.GetIDsOfNames	(Inherited from Attribute.)
	_Attribute.GetTypeInfo	(Inherited from Attribute.)
	_Attribute.GetTypeInfoCount	(Inherited from Attribute.)
	_Attribute.Invoke	(Inherited from Attribute.)

Top

Remarks

This attribute is applied to managed data flow components that derive from PipelineComponent. The attribute identifies a class as a managed data flow component and provides information through its properties that controls how the SSIS Designer displays and interacts with the object.

Examples

The following example shows a managed data flow component that implements this attribute.

[DtsPipelineComponent(DisplayName="MyComponent", ComponentType=ComponentType.Transform)]
public class MyComponent: PipelineComponent
{}

DtsPipelineComponent(DisplayName="MyComponent", ComponentType=ComponentType.Transform)> _ 
Public Class MyComponent 
Inherits PipelineComponent 
End Class

Thread Safety

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

Share via