HelpKeywordAttribute HelpKeywordAttribute HelpKeywordAttribute HelpKeywordAttribute Class

Definizione

Specifica la parola chiave di contesto per una classe o un membro.Specifies the context keyword for a class or member. Questa classe non può essere ereditata.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
Ereditarietà
HelpKeywordAttributeHelpKeywordAttributeHelpKeywordAttributeHelpKeywordAttribute
Attributi

Esempi

Esempio di codice seguente viene illustrato come eseguire l'override di questo comportamento del sistema della Guida posizionando l'attributo del membro stesso.The following code example shows how to override this Help system behavior by placing the attribute on the member itself. Queste sono le parole chiave per la classe seguente, chiamato DemoComponent:These are the keywords for the following class, called DemoComponent:

  • Parola chiave della classe: "System.ComponentModel.Component" (DemoNamespace.DemoComponent)Class keyword: "System.ComponentModel.Component" (DemoNamespace.DemoComponent)

  • Parola chiave Property1: "DemoNamespace.DemoComponent.Property1" (impostazione predefinita)Property1 keyword: "DemoNamespace.DemoComponent.Property1" (default)

  • Parola chiave Property2: "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 "";  
        }  
    }  
}  

Esempio di codice seguente illustra l'uso di HelpKeywordAttribute classe per specificare una parola chiave del contesto.The following code example demonstrates using the HelpKeywordAttribute class to specify a context keyword. Per una spiegazione completa di questo esempio di codice, vedere come: Applicare attributi nei controlli di Windows Form.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

Commenti

Per impostazione predefinita, la parola chiave della Guida per una classe viene fornita la Type.FullName valore della proprietà.By default, the Help keyword for a class is given by the Type.FullName property value. Per i membri, la parola chiave della Guida verrà specificata tramite il nome completo del tipo dichiarato della proprietà, più il nome della proprietà stessa.For members, the Help keyword is given by the full name of the type that declared the property, plus the property name itself.

Si consideri, ad esempio, il Control.Text proprietà di System.Windows.Forms.Button controllo.For example, consider the Control.Text property on the System.Windows.Forms.Button control. La parola chiave è "Button", ma il Control.Text parola chiave della proprietà è "Control. Text", perché il Control.Text proprietà è dichiarata nel System.Windows.Forms.Control (classe), anziché quella di System.Windows.Forms.Button classe stessa ; il System.Windows.Forms.Button classe eredita la proprietà.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.

Al contrario, il Button.DialogResult proprietà è dichiarata nel System.Windows.Forms.Button classe, pertanto la parola chiave è "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".

Quando il sistema di Guida ottiene le parole chiave, vengono prima di tutto esaminati HelpKeywordAttribute.When the Help system gets the keywords, it will first look at HelpKeywordAttribute. A livello di classe, verrà restituito la stringa specificata tramite il HelpKeywordAttribute.At the class level, it will return the string specified by the HelpKeywordAttribute. Non sarà utilizzabile per i membri del tipo in questione, che continuano a riflettere nome completo effettivo del tipo dichiarante, nonché il nome del membro.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. Questo attributo supporta classi fortemente tipizzate che sono associati documentazione comune, ma distinti ID Guida.This attribute supports strongly typed classes that have associated common documentation but distinct Help IDs.

Costruttori

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

Inizializza una nuova istanza della classe HelpKeywordAttribute.Initializes a new instance of the HelpKeywordAttribute class.

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

Inizializza una nuova istanza della classe HelpKeywordAttribute.Initializes a new instance of the HelpKeywordAttribute class.

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

Inizializza una nuova istanza della classe HelpKeywordAttribute per il tipo indicato.Initializes a new instance of the HelpKeywordAttribute class from the given type.

Campi

Default Default Default Default

Rappresenta il valore predefinito dell'attributo HelpKeywordAttribute.Represents the default value for HelpKeywordAttribute. Questo campo è di sola lettura.This field is read-only.

Proprietà

HelpKeyword HelpKeyword HelpKeyword HelpKeyword

Ottiene la parola chiave della Guida fornita da questo attributo.Gets the Help keyword supplied by this attribute.

TypeId TypeId TypeId TypeId

Quando è implementata in una classe derivata, ottiene un identificatore univoco della classe Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Metodi

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

Determina se due istanze di HelpKeywordAttribute sono uguali.Determines whether two HelpKeywordAttribute instances are equal.

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

Restituisce il codice hash per l'istanza.Returns the hash code for this instance.

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

Ottiene l'oggetto Type dell'istanza corrente.Gets the Type of the current instance.

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

Determina se la parola chiave della Guida è null.Determines whether the Help keyword is null.

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

Quando è sottoposto a override in una classe derivata, restituisce un valore che indica se questa istanza equivale a un oggetto specificato.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()

Crea una copia superficiale dell'oggetto Object corrente.Creates a shallow copy of the current Object.

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

Restituisce una stringa che rappresenta l'oggetto corrente.Returns a string that represents the current object.

(Inherited from Object)

Implementazioni dell'interfaccia esplicita

_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)

Esegue il mapping di un set di nomi a un set corrispondente di ID dispatch.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)

Recupera le informazioni sul tipo relative a un oggetto, che possono essere usate per ottenere informazioni sul tipo relative a un'interfaccia.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)

Recupera il numero delle interfacce di informazioni sul tipo fornite da un oggetto (0 o 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)

Fornisce l'accesso a proprietà e metodi esposti da un oggetto.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Si applica a