HelpKeywordAttribute Classe

Definizione

Spazio dei nomi:

System.ComponentModel.Design

Assembly:

System.ComponentModel.TypeConverter.dll

Origine:

HelpKeywordAttribute.cs

Specifica la parola chiave del contesto per una classe o un membro. La classe non può essere ereditata.

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

Ereditarietà

Object

Attribute

HelpKeywordAttribute

Attributi

AttributeUsageAttribute

Esempio

Nell'esempio di codice seguente viene illustrato come eseguire l'override del comportamento del sistema della Guida inserendo l'attributo nel membro stesso. Queste sono le parole chiave per la classe seguente, denominata DemoComponent:

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

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

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

Nell'esempio di codice seguente viene illustrato l'uso della HelpKeywordAttribute classe per specificare una parola chiave di contesto. Per una spiegazione completa di questo esempio di codice, vedere Procedura: Applicare attributi nei controlli Windows Forms.

// 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 specificata dal valore della Type.FullName proprietà. Per i membri, la parola chiave Della Guida viene specificata dal nome completo del tipo che ha dichiarato la proprietà, oltre al nome della proprietà stesso.

Si consideri ad esempio la Control.Text proprietà nel System.Windows.Forms.Button controllo. La parola chiave della classe è "System.Windows. Forms. Button", ma la Control.Text parola chiave della proprietà è "System.Windows.Forms. Control.Text", perché la Control.Text proprietà viene dichiarata nella System.Windows.Forms.Control classe, anziché nella System.Windows.Forms.Button classe stessa. La System.Windows.Forms.Button classe eredita la proprietà.

Al contrario, la proprietà viene dichiarata nella System.Windows.Forms.Button classe, quindi la Button.DialogResult parola chiave è "System.Windows.Forms. Button.DialogResult".

Quando il sistema della Guida ottiene le parole chiave, verrà prima esaminato HelpKeywordAttribute. A livello di classe, restituirà la stringa specificata da HelpKeywordAttribute. Questa operazione non verrà usata per i membri del tipo in questione, che rifletterà comunque il nome completo effettivo del tipo dichiarante, oltre al nome del membro. Questo attributo supporta classi fortemente tipizzata che hanno associato documentazione comune, ma id guida distinti.

Costruttori

HelpKeywordAttribute()	Inizializza una nuova istanza della classe HelpKeywordAttribute.
HelpKeywordAttribute(String)	Inizializza una nuova istanza della classe HelpKeywordAttribute.
HelpKeywordAttribute(Type)	Inizializza una nuova istanza della classe HelpKeywordAttribute per il tipo indicato.

Campi

Default

Rappresenta il valore predefinito dell'attributo HelpKeywordAttribute. Questo campo è di sola lettura.

Proprietà

HelpKeyword	Ottiene la parola chiave della Guida fornita da questo attributo.
TypeId	Quando è implementata in una classe derivata, ottiene un identificatore univoco della classe Attribute. (Ereditato da Attribute)

Metodi

Equals(Object)	Determina se due istanze di HelpKeywordAttribute sono uguali.
GetHashCode()	Restituisce il codice hash per l'istanza.
GetType()	Ottiene l'oggetto Type dell'istanza corrente. (Ereditato da Object)
IsDefaultAttribute()	Determina se la parola chiave della Guida è null.
Match(Object)	Quando è sottoposto a override in una classe derivata, restituisce un valore che indica se questa istanza equivale a un oggetto specificato. (Ereditato da Attribute)
MemberwiseClone()	Crea una copia superficiale dell'oggetto Object corrente. (Ereditato da Object)
ToString()	Restituisce una stringa che rappresenta l'oggetto corrente. (Ereditato da Object)