HelpContextAttribute Class

Article
04/26/2013

Defines a HelpContextAttribute attribute for the HelpContextAttribute class.

Inheritance Hierarchy

System.Object
System.Attribute
Microsoft.SqlServer.Dts.Design.HelpContextAttribute

Namespace: Microsoft.SqlServer.Dts.Design
Assembly: Microsoft.SqlServer.Dts.Design (in Microsoft.SqlServer.Dts.Design.dll)

Syntax

'Declaration
<AttributeUsageAttribute(AttributeTargets.Class Or AttributeTargets.Field, AllowMultiple := False)> _
Public NotInheritable Class HelpContextAttribute _
    Inherits Attribute
'Usage
Dim instance As HelpContextAttribute

[AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Field, AllowMultiple = false)]
public sealed class HelpContextAttribute : Attribute

[AttributeUsageAttribute(AttributeTargets::Class|AttributeTargets::Field, AllowMultiple = false)]
public ref class HelpContextAttribute sealed : public Attribute

[<SealedAttribute>]
[<AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Field, AllowMultiple = false)>]
type HelpContextAttribute =  
    class 
        inherit Attribute 
    end

public final class HelpContextAttribute extends Attribute

The HelpContextAttribute type exposes the following members.

Constructors

	Name	Description
	HelpContextAttribute(String)	Initializes a new instance of the HelpContextAttribute class by using an F1 keyword parameter.
	HelpContextAttribute(String, String, String)	Initializes a new instance of the HelpContextAttribute class by using the F1 keyword, collection, and filter parameters.

Top

Properties

	Name	Description
	F1Keyword	Gets or sets a String containing the keyword to be used in looking up Help.
	HelpCollection	Gets or sets a String containing the Help collection from which to retrieve the Help.
	HelpFilter	Gets or sets a String containing any filters that are in place to narrow down the search in the Help collection.
	TypeId	(Inherited from Attribute.)

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

Attributes enable programmers to attach custom information to various program entities and retrieve attribute information in a run-time environment. In the runtime, a custom attribute, such as HelpContextAttribute, allows you to use this property to signal and display context-sensitive Help for an application.

The HelpContextAttribute inherits from the attribute class in the Microsoft .NET Framework.

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