HelpKeywordAttribute Class

Definition

Namespace:

System.ComponentModel.Design

Assembly:

System.ComponentModel.TypeConverter.dll

Source:

HelpKeywordAttribute.cs

Specifies the context keyword for a class or member. This class cannot be inherited.

public ref class HelpKeywordAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.All, AllowMultiple=false, Inherited=false)]
public sealed class HelpKeywordAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.All, AllowMultiple=false, Inherited=false)>]
type HelpKeywordAttribute = class
    inherit Attribute

Public NotInheritable Class HelpKeywordAttribute
Inherits Attribute

Inheritance

Object

Attribute

HelpKeywordAttribute

Attributes

AttributeUsageAttribute

Examples

The following code example shows how to override this Help system behavior by placing the attribute on the member itself. These are the keywords for the following class, called DemoComponent:

• Class keyword: "System.ComponentModel.Component" (DemoNamespace.DemoComponent)

• Property1 keyword: "DemoNamespace.DemoComponent.Property1" (default)

• Property2 keyword: "SomeNamespace.SomeOtherClass.Property2" (DemoNamespace.DemoComponent.Property2)

[HelpKeywordAttribute(typeof(Component))]  
public class DemoComponent : Component  
{  
    public string Property1  
    {  
        get  
        {  
            return "";  
        }  
    }  

    [HelpKeywordAttribute("SomeNamespace.SomeOtherClass.Property2")]  
    public string Property2  
    {  
        get  
        {  
            return "";  
        }  
    }  
}  

The following code example demonstrates using the HelpKeywordAttribute class to specify a context keyword. For a complete explanation of this code example, see How to: Apply Attributes in Windows Forms Controls.

// This control demonstrates a simple logging capability. 
[ComplexBindingProperties("DataSource", "DataMember")]
[DefaultBindingProperty("TitleText")]
[DefaultEvent("ThresholdExceeded")]
[DefaultProperty("Threshold")]
[HelpKeywordAttribute(typeof(UserControl))]
[ToolboxItem("System.Windows.Forms.Design.AutoSizeToolboxItem,System.Design")]
public class AttributesDemoControl : UserControl
{

' This control demonstrates a simple logging capability. 
<ComplexBindingProperties("DataSource", "DataMember"), _
DefaultBindingProperty("TitleText"), _
DefaultEvent("ThresholdExceeded"), _
DefaultProperty("Threshold"), _
HelpKeywordAttribute(GetType(UserControl)), _
ToolboxItem("System.Windows.Forms.Design.AutoSizeToolboxItem,System.Design")> _
Public Class AttributesDemoControl
    Inherits UserControl

Remarks

By default, the Help keyword for a class is given by the Type.FullName property value. For members, the Help keyword is given by the full name of the type that declared the property, plus the property name itself.

For example, consider the Control.Text property on the System.Windows.Forms.Button control. The class keyword is "System.Windows.Forms.Button", but the Control.Text property keyword is "System.Windows.Forms.Control.Text", because the Control.Text property is declared on the System.Windows.Forms.Control class, rather than the System.Windows.Forms.Button class itself; the System.Windows.Forms.Button class inherits the property.

By contrast, the Button.DialogResult property is declared on the System.Windows.Forms.Button class, so its keyword is "System.Windows.Forms.Button.DialogResult".

When the Help system gets the keywords, it will first look at HelpKeywordAttribute. At the class level, it will return the string specified by the HelpKeywordAttribute. This will not be used for members of the type in question, which will still reflect the declaring type's actual full name, plus the member name. This attribute supports strongly typed classes that have associated common documentation but distinct Help IDs.

Constructors

HelpKeywordAttribute()	Initializes a new instance of the HelpKeywordAttribute class.
HelpKeywordAttribute(String)	Initializes a new instance of the HelpKeywordAttribute class.
HelpKeywordAttribute(Type)	Initializes a new instance of the HelpKeywordAttribute class from the given type.

Fields

Default

Represents the default value for HelpKeywordAttribute. This field is read-only.

Properties

HelpKeyword	Gets the Help keyword supplied by this attribute.
TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)

Methods

Equals(Object)	Determines whether two HelpKeywordAttribute instances are equal.
GetHashCode()	Returns the hash code for this instance.
GetType()	Gets the Type of the current instance. (Inherited from Object)
IsDefaultAttribute()	Determines whether the Help keyword is null.
Match(Object)	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)