HelpKeywordAttribute HelpKeywordAttribute HelpKeywordAttribute HelpKeywordAttribute Class

Definition

Gibt das Kontextschlüsselwort für eine Klasse oder einen Member an.Specifies the context keyword for a class or member. Diese Klasse kann nicht vererbt werden.This class cannot be inherited.

public ref class HelpKeywordAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.All, AllowMultiple=false, Inherited=false)]
[System.Serializable]
public sealed class HelpKeywordAttribute : Attribute
type HelpKeywordAttribute = class
    inherit Attribute
Public NotInheritable Class HelpKeywordAttribute
Inherits Attribute
Vererbung
HelpKeywordAttributeHelpKeywordAttributeHelpKeywordAttributeHelpKeywordAttribute
Attribute

Beispiele

Im folgenden Codebeispiel wird veranschaulicht, wie diese Hilfe Systemverhalten zu überschreiben, indem Sie das Attribut auf das Element selbst platziert wird.The following code example shows how to override this Help system behavior by placing the attribute on the member itself. Hierbei handelt es sich um die Schlüsselwörter für die folgende Klasse namens DemoComponent:These are the keywords for the following class, called DemoComponent:

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

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

  • Property2-Schlüsselwort: "SomeNamespace.SomeOtherClass.Property2" (DemoNamespace.DemoComponent.Property2)Property2 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, um ein Kontextschlüsselwort anzugeben.The following code example demonstrates using the HelpKeywordAttribute class to specify a context keyword. Eine vollständige Erläuterung dieses Codebeispiels, finden Sie unter Vorgehensweise: Anwenden von Attributen auf Windows Forms-Steuerelemente.For a complete explanation of this code example, see How to: Apply Attributes 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 erhält das Hilfeschlüsselwort für eine Klasse von der Type.FullName -Eigenschaftswert.By default, the Help keyword for a class is given by the Type.FullName property value. Für Mitglieder erhält das Schlüsselwort für Hilfe durch den vollständigen Namen des Typs, der die Eigenschaft deklariert, sowie den Namen der Eigenschaft selbst.For members, the Help keyword is given by the full name of the type that declared the property, plus the property name itself.

Betrachten Sie beispielsweise die Control.Text Eigenschaft für die System.Windows.Forms.Button Steuerelement.For example, consider the Control.Text property on the System.Windows.Forms.Button control. Die Class-Schlüsselwort ist "System.Windows.Forms.Button", aber die Control.Text lautet "Jedoch System.Windows.Forms.Control.Text", da die Control.Text Eigenschaft wird deklariert, auf die System.Windows.Forms.Control -Klasse, statt auf den System.Windows.Forms.Button selbst ; die System.Windows.Forms.Button Klasse erbt die Eigenschaft.The class keyword is "System.Windows.Forms.Button", but the Control.Text property keyword is "System.Windows.Forms.Control.Text", because the Control.Text property is declared on the System.Windows.Forms.Control class, rather than the System.Windows.Forms.Button class itself; the System.Windows.Forms.Button class inherits the property.

Im Gegensatz dazu die Button.DialogResult Eigenschaft wird deklariert, auf die System.Windows.Forms.Button Klasse, daher das Schlüsselwort ist "System.Windows.Forms.Button.DialogResult".By contrast, the Button.DialogResult property is declared on the System.Windows.Forms.Button class, so its keyword is "System.Windows.Forms.Button.DialogResult".

Wenn das Hilfesystem der Schlüsselwörter abruft, dabei wird zunächst betrachtet HelpKeywordAttribute.When the Help system gets the keywords, it will first look at HelpKeywordAttribute. Auf Klassenebene, gibt es der angegebenen Zeichenfolge das HelpKeywordAttribute.At the class level, it will return the string specified by the HelpKeywordAttribute. Dies wird für Member des betreffenden Typs die immer noch der deklarierende Typ des tatsächlichen vollständigen Namen und den Namen des Members angegeben wird, nicht verwendet werden.This will not be used for members of the type in question, which will still reflect the declaring type's actual full name, plus the member name. Dieses Attribut unterstützt stark typisierte Klassen, die allgemeine Dokumentation jedoch unterschiedliche Hilfe-IDs verknüpft haben.This attribute supports strongly typed classes that have associated common documentation but distinct Help IDs.

Konstruktoren

HelpKeywordAttribute() HelpKeywordAttribute() HelpKeywordAttribute() HelpKeywordAttribute()

Initialisiert eine neue Instanz der HelpKeywordAttribute-Klasse.Initializes a new instance of the HelpKeywordAttribute class.

HelpKeywordAttribute(String) HelpKeywordAttribute(String) HelpKeywordAttribute(String) HelpKeywordAttribute(String)

Initialisiert eine neue Instanz der HelpKeywordAttribute-Klasse.Initializes a new instance of the HelpKeywordAttribute class.

HelpKeywordAttribute(Type) HelpKeywordAttribute(Type) HelpKeywordAttribute(Type) HelpKeywordAttribute(Type)

Initialisiert eine neue Instanz der HelpKeywordAttribute-Klasse für den angegebenen Typ.Initializes a new instance of the HelpKeywordAttribute class from the given type.

Felder

Default Default Default Default

Stellt den Standardwert für HelpKeywordAttribute dar.Represents the default value for HelpKeywordAttribute. Dieses Feld ist schreibgeschützt.This field is read-only.

Eigenschaften

HelpKeyword HelpKeyword HelpKeyword HelpKeyword

Ruft das von diesem Attribut angegebene Hilfeschlüsselwort ab.Gets the Help keyword supplied by this attribute.

TypeId TypeId TypeId TypeId

Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Methoden

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Stellt fest, ob zwei HelpKeywordAttribute-Instanzen gleich sind.Determines whether two HelpKeywordAttribute instances are equal.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Gibt den Hashcode für diese Instanz zurück.Returns the hash code for this instance.

GetType() GetType() GetType() GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute()

Bestimmt, ob das Hilfeschlüsselwort null lautet.Determines whether the Help keyword is null.

Match(Object) Match(Object) Match(Object) Match(Object)

Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Inherited from Object)

Explizite Schnittstellenimplementierungen

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Ordnet eine Reihe von Namen einer entsprechenden Reihe von Dispatchbezeichnern zu.Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _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.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32)

Ruft die Anzahl der Schnittstellen mit Typinformationen ab, die von einem Objekt bereitgestellt werden (0 oder 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Stellt den Zugriff auf von einem Objekt verfügbar gemachte Eigenschaften und Methoden bereit.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Gilt für: