HelpKeywordAttribute Klasse

Definition

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

Vererbung

Object

Attribute

HelpKeywordAttribute

Attribute

AttributeUsageAttribute SerializableAttribute

Beispiele

Das folgende Codebeispiel zeigt, wie Sie dieses Hilfesystemverhalten außer Kraft setzen, indem Sie das Attribut für das Element selbst platzieren. Dies sind die Schlüsselwörter für die folgende Klasse, die aufgerufen wird DemoComponent:

• Class-Schlüsselwort: "System.ComponentModel.Component" (DemoNamespace.DemoComponent)

• Property1-Schlüsselwort: "DemoNamespace.DemoComponent.Property1" (Standard)

• Property2-Schlüsselwort: "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 "";
        }
    }
}

Im folgenden Codebeispiel wird die Verwendung der HelpKeywordAttribute Klasse zum Angeben eines Kontextstichworts veranschaulicht. Eine vollständige Erläuterung dieses Codebeispiels finden Sie unter How to: Apply Attributes in Windows Forms Controls.

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

Hinweise

Standardmäßig wird das Hilfeschlüsselwort für eine Klasse durch den Type.FullName Eigenschaftswert angegeben. Für Member wird das Hilfe-Schlüsselwort durch den vollständigen Namen des Typs angegeben, der die Eigenschaft deklariert hat, sowie den Eigenschaftennamen selbst.

Betrachten Sie beispielsweise die Control.Text Eigenschaft für das System.Windows.Forms.Button Steuerelement. Das Klassenschlüsselwort lautet "System.Windows.Forms.Button", aber das Control.Text Schlüsselwort der Eigenschaft lautet "System.Windows.Forms.Control.Text", da die Control.Text Eigenschaft für die System.Windows.Forms.Control Klasse und nicht für die System.Windows.Forms.Button Klasse selbst deklariert wird; die Klasse erbt die System.Windows.Forms.Button Eigenschaft.

Im Gegensatz dazu wird die Button.DialogResult Eigenschaft für die System.Windows.Forms.Button Klasse deklariert, sodass das Schlüsselwort "System.Windows.Forms.Button.DialogResult" lautet.

Wenn das Hilfesystem die Schlüsselwörter abruft, wird es zuerst angezeigt HelpKeywordAttribute. Auf Klassenebene gibt sie die durch die HelpKeywordAttribute. Dies wird nicht für Elemente des betreffenden Typs verwendet, was den tatsächlichen vollständigen Namen des deklarierenden Typs sowie den Membernamen widerspiegelt. Dieses Attribut unterstützt stark typierte Klassen, die allgemeine Dokumentationen zugeordnet haben, jedoch unterschiedliche Hilfe-IDs.