HelpKeywordAttribute Class
Collapse the table of content
Expand the table of content

HelpKeywordAttribute Class

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

Namespace: System.ComponentModel.Design
Assembly: System (in system.dll)

[AttributeUsageAttribute(AttributeTargets.All, AllowMultiple=false, Inherited=false)] 
public sealed class HelpKeywordAttribute : Attribute
/** @attribute SerializableAttribute() */ 
/** @attribute AttributeUsageAttribute(AttributeTargets.All, AllowMultiple=false, Inherited=false) */ 
public final class HelpKeywordAttribute extends Attribute
AttributeUsageAttribute(AttributeTargets.All, AllowMultiple=false, Inherited=false) 
public final class HelpKeywordAttribute extends Attribute
Not applicable.

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.

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)

public class DemoComponent : Component
    public string Property1
            return "";

    public string Property2
            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")]
public class AttributesDemoControl : UserControl


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

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

© 2015 Microsoft