DtsTaskAttribute Class

Article
04/26/2013

Supplies design time information about a Task object.

Inheritance Hierarchy

System.Object
  System.Attribute
    Microsoft.SqlServer.Dts.Runtime.Localization.DtsLocalizableAttribute
      Microsoft.SqlServer.Dts.Runtime.DtsTaskAttribute

Namespace: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in Microsoft.SqlServer.ManagedDTS.dll)

Syntax

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

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

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

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

public final class DtsTaskAttribute extends DtsLocalizableAttribute

The DtsTaskAttribute type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	Description	Infrastructure. Gets or sets the description of the DtsLocalizableAttribute. (Inherited from DtsLocalizableAttribute.)
	DisplayName	Infrastructure. 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 task object.
	IconResource	Gets or sets the icon associated with the task object.
	LocalizationType	Infrastructure. Gets or sets the class that supplies values for the DtsLocalizableAttribute. (Inherited from DtsLocalizableAttribute.)
	RequiredProductLevel	Gets or sets a value from the DTSProductLevel enumeration so you can specify a specific product that this task is used with in the attribute.
	SamplesTag	Gets or sets the samples tag from the task.
	TaskContact	Gets or sets the contact information for the task.
	TaskType	Gets or sets the type of the task.
	TypeId	(Inherited from Attribute.)
	UITypeName	Specifies the qualified name of the assembly that implements the user interface of the task.

Top

Methods

	Name	Description
	Equals	(Inherited from Attribute.)
	GetHashCode	(Inherited from Attribute.)
	GetType	(Inherited from Object.)
	IsDefaultAttribute	(Inherited from Attribute.)
	Match	(Inherited from Attribute.)
	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 tasks that are derived from Task. The attribute identifies a class as a managed task and provides information through its properties that control how the SSIS Designer displays and interacts with the object.

The DisplayName property is displayed in the Toolbox of tasks in the SQL Server Data Tools (SSDT).

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