HelpContextAttribute Class

 

Defines a HelpContextAttribute attribute for the HelpContextAttribute class.

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

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

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

NameDescription
System_CAPS_pubmethodHelpContextAttribute(String)

Initializes a new instance of the HelpContextAttribute class by using an F1 keyword parameter.

System_CAPS_pubmethodHelpContextAttribute(String, String, String)

Initializes a new instance of the HelpContextAttribute class by using the F1 keyword, collection, and filter parameters.

NameDescription
System_CAPS_pubpropertyF1Keyword

Gets or sets a String containing the keyword to be used in looking up Help.

System_CAPS_pubpropertyHelpCollection

Gets or sets a String containing the Help collection from which to retrieve the Help.

System_CAPS_pubpropertyHelpFilter

Gets or sets a String containing any filters that are in place to narrow down the search in the Help collection.

System_CAPS_pubpropertyTypeId

(Inherited from Attribute.)

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Attribute.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Attribute.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodIsDefaultAttribute()

(Inherited from Attribute.)

System_CAPS_pubmethodMatch(Object)

(Inherited from Attribute.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

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.

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

Return to top
Show: