Dieser Artikel wurde maschinell übersetzt. Wenn Sie die englische Version des Artikels anzeigen möchten, aktivieren Sie das Kontrollkästchen Englisch. Sie können den englischen Text auch in einem Popupfenster anzeigen, indem Sie den Mauszeiger über den Text bewegen.
Übersetzung
Englisch

HelpKeywordAttribute-Klasse

 

Veröffentlicht: Oktober 2016

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

Namespace:   System.ComponentModel.Design
Assembly:  System (in System.dll)

System.Object
  System.Attribute
    System.ComponentModel.Design.HelpKeywordAttribute

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

NameBeschreibung
System_CAPS_pubmethodHelpKeywordAttribute()

Initialisiert eine neue Instanz der HelpKeywordAttribute-Klasse.

System_CAPS_pubmethodHelpKeywordAttribute(String)

Initialisiert eine neue Instanz der HelpKeywordAttribute-Klasse.

System_CAPS_pubmethodHelpKeywordAttribute(Type)

Initialisiert eine neue Instanz der HelpKeywordAttribute -Klasse aus den angegebenen Typ.

NameBeschreibung
System_CAPS_pubpropertyHelpKeyword

Ruft das von diesem Attribut angegebene Hilfeschlüsselwort ab.

System_CAPS_pubpropertyTypeId

Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab.(Geerbt von „Attribute“.)

NameBeschreibung
System_CAPS_pubmethodEquals(Object)

Stellt fest, ob zwei HelpKeywordAttribute-Instanzen gleich sind.(Überschreibt Attribute.Equals(Object).)

System_CAPS_pubmethodGetHashCode()

Gibt den Hashcode für diese Instanz zurück.(Überschreibt Attribute.GetHashCode().)

System_CAPS_pubmethodGetType()

Ruft den Type der aktuellen Instanz ab.(Geerbt von „Object“.)

System_CAPS_pubmethodIsDefaultAttribute()

Bestimmt, ob das Hilfeschlüsselwort null.(Überschreibt Attribute.IsDefaultAttribute().)

System_CAPS_pubmethodMatch(Object)

Ruft beim Überschreiben in einer abgeleiteten Klasse gibt einen Wert, der angibt, ob diese Instanz gleich ein angegebenen Objekt ist.(Geerbt von „Attribute“.)

System_CAPS_pubmethodToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.(Geerbt von „Object“.)

NameBeschreibung
System_CAPS_pubfieldSystem_CAPS_staticDefault

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

NameBeschreibung
System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Ordnet eine Reihe von Namen einer entsprechenden Reihe von Dispatchbezeichnern zu.(Geerbt von „Attribute“.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_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“.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.GetTypeInfoCount(UInt32)

Ruft die Anzahl der Schnittstellen mit Typinformationen ab, die von einem Objekt bereitgestellt werden (0 oder 1).(Geerbt von „Attribute“.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_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“.)

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

Betrachten Sie z. B. die Control.Text Eigenschaft auf den System.Windows.Forms.Button Steuerelement. Das Klassenschlüsselwort ist "System.Windows.Forms.Button", aber die Control.Text lautet jedoch "System.Windows.Forms.Control.Text", denn die Control.Text Eigenschaft deklariert wird, auf die System.Windows.Forms.Control -Klasse anstelle der System.Windows.Forms.Button selbst dar; die System.Windows.Forms.Button -Klasse erbt die Eigenschaft.

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

Wenn das Hilfesystem die Schlüsselwörter abruft, zuerst geprüft HelpKeywordAttribute. Auf der Ebene der Klasse, die durch angegebene Zeichenfolge zurückgegeben der HelpKeywordAttribute. Dies wird nicht für Elemente des betreffenden Typs verwendet werden die vollständigen Namen der deklarierende Typ sowie den Membernamen weiterhin widerspiegeln wird. Dieses Attribut unterstützt stark typisierte Klassen, die allgemeine Dokumentation jedoch unterschiedliche Hilfe-IDs zugeordnet sind.

Im folgenden Codebeispiel wird veranschaulicht, wie Verhalten dieses Hilfesystems zu überschreiben, indem Sie das Attribut auf das Element selbst platziert wird. Dies sind die Schlüsselwörter für die folgende Klasse mit dem Namen 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 "";
        }
    }
}

Das folgende Codebeispiel veranschaulicht die Verwendung der HelpKeywordAttribute -Klasse ein Kontextschlüsselwort angegeben. Eine vollständige Erläuterung dieses Codebeispiels, finden Sie unter Gewusst wie: Anwenden von Attributen auf Windows Forms-Steuerelemente.

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

.NET Framework
Verfügbar seit 2.0

Alle öffentlichen statischen Member ( Shared in Visual Basic) dieses Typs sind threadsicher. Die Threadsicherheit für Instanzmember ist nicht garantiert.

Zurück zum Anfang
Anzeigen: