HelpKeywordAttribute Klasse

Referenz

Definition

Namespace:: System.ComponentModel.Design

Assembly:: System.ComponentModel.TypeConverter.dll

Assembly:: System.dll

Assembly:: netstandard.dll

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

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)]
[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

Im folgenden Codebeispiel wird gezeigt, wie Sie dieses Hilfesystemverhalten außer Kraft setzen, indem Sie das Attribut selbst auf das Element setzen. Dies sind die Schlüsselwörter für die folgende Klasse namens DemoComponent:

Klassenwort: "System.ComponentModel.Component" (DemoNamespace.DemoComponent)
Eigenschaft1-Schlüsselwort: "DemoNamespace.DemoComponent.Property1" (Standard)
Eigenschaft2-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 veranschaulicht, um ein Kontextwort anzugeben. Eine vollständige Erläuterung dieses Codebeispiels finden Sie unter How to: Apply Attribute in Windows Forms Controls.

// 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 das Hilfeschlüsselwort für eine Klasse vom Type.FullName Eigenschaftswert angegeben. Bei Mitgliedern wird das Hilfewort durch den vollständigen Namen des Typs angegeben, der die Eigenschaft deklariert hat, sowie den Eigenschaftennamen selbst.

Betrachten Sie beispielsweise die Control.Text Eigenschaft im System.Windows.Forms.Button Steuerelement. Das Klassenwort lautet "System. Windows. Forms.Button", aber das Control.Text Eigenschaftswort lautet "System.Windows. Forms.Control.Text", da die Control.Text Eigenschaft für die System.Windows.Forms.Control Klasse deklariert wird, anstatt System.Windows.Forms.Button die Klasse selbst. Die System.Windows.Forms.Button Klasse erbt die Eigenschaft.

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

Wenn das Hilfesystem die Schlüsselwörter abruft, wird es zuerst angezeigt HelpKeywordAttribute. Auf Klassenebene gibt sie die von der HelpKeywordAttributeZeichenfolge angegebene Zeichenfolge zurück. Dies wird nicht für Mitglieder des betreffenden Typs verwendet, der weiterhin den tatsächlichen vollständigen Namen des deklarierenden Typs sowie den Membernamen widerspiegelt. Dieses Attribut unterstützt stark typierte Klassen, die gemeinsame Dokumentation zugeordnet haben, aber unterschiedliche Hilfe-IDs.

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)

Explizite Schnittstellenimplementierungen

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Ordnet eine Reihe von Namen einer entsprechenden Reihe von Dispatchbezeichnern zu. (Geerbt von Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Ruft die Typinformationen für ein Objekt ab, mit deren Hilfe die Typinformationen für eine Schnittstelle abgerufen werden können. (Geerbt von Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Ruft die Anzahl der Schnittstellen mit Typinformationen ab, die von einem Objekt bereitgestellt werden (0 oder 1). (Geerbt von Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Stellt den Zugriff auf von einem Objekt verfügbar gemachte Eigenschaften und Methoden bereit. (Geerbt von Attribute)

Gilt für