HelpKeywordAttribute クラスとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

HelpKeywordAttribute クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

クラスまたはメンバのコンテキストキーワードを指定します。このクラスは継承できません。

名前空間: System.ComponentModel.Design
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

<SerializableAttribute> _
<AttributeUsageAttribute(AttributeTargets.All, AllowMultiple:=False, Inherited:=False)>
 _
Public NotInheritable Class
 HelpKeywordAttribute
    Inherits Attribute

Visual Basic (使用法)

Dim instance As HelpKeywordAttribute

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

C++

[SerializableAttribute] 
[AttributeUsageAttribute(AttributeTargets::All, AllowMultiple=false,
 Inherited=false)] 
public ref class HelpKeywordAttribute sealed
 : public Attribute

/** @attribute SerializableAttribute() */ 
/** @attribute AttributeUsageAttribute(AttributeTargets.All, AllowMultiple=false,
 Inherited=false) */ 
public final class HelpKeywordAttribute extends
 Attribute

JScript

SerializableAttribute 
AttributeUsageAttribute(AttributeTargets.All, AllowMultiple=false,
 Inherited=false) 
public final class HelpKeywordAttribute extends
 Attribute

解説

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

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

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

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

使用例

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

クラスキーワード : "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 フォームコントロールに属性を適用する」を参照してください。

Visual Basic

' 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

// 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
{