HelpKeywordAttribute クラス

定義

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)]
[System.Serializable]
public sealed class HelpKeywordAttribute : Attribute

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

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

Public NotInheritable Class HelpKeywordAttribute
Inherits Attribute

継承

Object

Attribute

HelpKeywordAttribute

属性

AttributeUsageAttribute SerializableAttribute

例

次のコード例は、メンバー自体に属性を配置して、このヘルプ システムの動作をオーバーライドする方法を示しています。 次のクラスのキーワードは、 DemoComponentと呼ばれます。

• Class キーワード: "System.ComponentModel.Component" (DemoNamespace.DemoComponent)

• Property1 キーワード: "DemoNamespace.DemoComponent.Property1" (既定値)

• Property2 キーワード: "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 "";
        }
    }
}

次のコード例は、 HelpKeywordAttribute クラスを使用してコンテキスト キーワードを指定する方法を示しています。 このコード例の完全な説明については、「 方法: Windows フォーム コントロールで属性を適用する」を参照してください。

// This control demonstrates a simple logging capability.
[ComplexBindingProperties("DataSource", "DataMember")]
[DefaultBindingProperty("TitleText")]
[DefaultEvent("ThresholdExceeded")]
[DefaultProperty("Threshold")]
[HelpKeyword(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

注釈

既定では、クラスの Help キーワードは、 Type.FullName プロパティ値によって指定されます。 メンバーの場合、Help キーワードは、プロパティを宣言した型の完全な名前と、プロパティ名自体によって指定されます。

たとえば、System.Windows.Forms.Button コントロールの Control.Text プロパティについて考えてみましょう。 クラス キーワードは "System.Windows.Forms.Button" ですが、Control.Text プロパティは System.Windows.Forms.Button クラス自体ではなく、System.Windows.Forms.Control クラスで宣言されているため、Control.Text プロパティ キーワードは "System.Windows.Forms.Control.Text" です。System.Windows.Forms.Button クラスはプロパティを継承します。

これに対し、 Button.DialogResult プロパティは System.Windows.Forms.Button クラスで宣言されているため、キーワードは "System.Windows.Forms.Button.DialogResult" です。

ヘルプ システムがキーワードを取得すると、最初に HelpKeywordAttributeが表示されます。 クラス レベルでは、 HelpKeywordAttributeで指定された文字列が返されます。 これは、問題の型のメンバーには使用されません。これは、宣言している型の実際の完全な名前とメンバー名を反映します。 この属性は、共通のドキュメントが関連付けられているが、個別のヘルプ ID を持つ、厳密に型指定されたクラスをサポートします。