HelpKeywordAttribute Klasse

Definition

Namespace:

System.ComponentModel.Design

Assembly:

System.ComponentModel.TypeConverter.dll

Quelle:

HelpKeywordAttribute.cs

Gibt das Kontextschlüsselwort für eine Klasse oder ein Element an. Diese Klasse kann nicht vererbt werden.

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

Vererbung

Object

Attribute

HelpKeywordAttribute

Attribute

AttributeUsageAttribute

Beispiele

Das folgende Codebeispiel zeigt, wie dieses Hilfesystemverhalten überschrieben wird, indem das Attribut auf dem Element selbst platziert wird. Dies sind die Schlüsselwörter für die folgende Klasse namens DemoComponent:

• Klasse Schlüsselwort (keyword): "System.ComponentModel.Component" (DemoNamespace.DemoComponent)

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

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

Das folgende Codebeispiel veranschaulicht die Verwendung der HelpKeywordAttribute -Klasse zum Angeben eines Kontexts Schlüsselwort (keyword). Eine vollständige Erläuterung dieses Codebeispiels finden Sie unter Vorgehensweise: Anwenden von Attributen in Windows Forms-Steuerelementen.

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

Hinweise

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

Betrachten Sie beispielsweise die Control.Text -Eigenschaft für das System.Windows.Forms.Button -Steuerelement. Die klasse Schlüsselwort (keyword) ist "System.Windows.Forms. Schaltfläche", aber die Control.Text Eigenschaft Schlüsselwort (keyword) ist "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, erbt die System.Windows.Forms.Button -Klasse die -Eigenschaft.

Im Gegensatz dazu wird die Button.DialogResult -Eigenschaft für die System.Windows.Forms.Button -Klasse deklariert, sodass ihr Schlüsselwort (keyword) "System.Windows.Forms. Button.DialogResult".

Wenn das Hilfesystem die Schlüsselwörter erhält, wird zuerst untersucht HelpKeywordAttribute. Auf Klassenebene wird die Zeichenfolge zurückgegeben, die HelpKeywordAttributedurch angegeben wird. Dies wird nicht für Member des betreffenden Typs verwendet, die weiterhin den tatsächlichen vollständigen Namen des deklarierenden Typs sowie den Membernamen widerspiegeln. Dieses Attribut unterstützt stark typisierte Klassen, die eine gemeinsame Dokumentation, aber unterschiedliche Hilfe-IDs aufweisen.

Konstruktoren

HelpKeywordAttribute()	Initialisiert eine neue Instanz der HelpKeywordAttribute-Klasse.
HelpKeywordAttribute(String)	Initialisiert eine neue Instanz der HelpKeywordAttribute-Klasse.
HelpKeywordAttribute(Type)	Initialisiert eine neue Instanz der HelpKeywordAttribute-Klasse für den angegebenen Typ.

Felder

Default

Stellt den Standardwert für HelpKeywordAttribute dar. Dieses Feld ist schreibgeschützt.

Eigenschaften

HelpKeyword	Ruft das von diesem Attribut angegebene Hilfeschlüsselwort ab.
TypeId	Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab. (Geerbt von Attribute)

Methoden

Equals(Object)	Stellt fest, ob zwei HelpKeywordAttribute-Instanzen gleich sind.
GetHashCode()	Gibt den Hashcode für diese Instanz zurück.
GetType()	Ruft den Type der aktuellen Instanz ab. (Geerbt von Object)
IsDefaultAttribute()	Bestimmt, ob das Hilfeschlüsselwort null lautet.
Match(Object)	Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht. (Geerbt von Attribute)
MemberwiseClone()	Erstellt eine flache Kopie des aktuellen Object. (Geerbt von Object)
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)