HelpKeywordAttribute Classe

Definizione

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

Ereditarietà

Object

Attribute

HelpKeywordAttribute

Attributi

AttributeUsageAttribute SerializableAttribute

Esempio

Nell'esempio di codice seguente viene illustrato come eseguire l'override di questo comportamento del sistema della Guida inserendo l'attributo sul membro stesso. Si tratta delle parole chiave per la classe seguente, denominata DemoComponent:

• Parola chiave Class: "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 context. Per una spiegazione completa di questo esempio di codice, vedere Procedura: Applicare attributi nei controlli Windows Form.

// This control demonstrates a simple logging capability.
[ComplexBindingProperties("DataSource", "DataMember")]
[DefaultBindingProperty("TitleText")]
[DefaultEvent("ThresholdExceeded")]
[DefaultProperty("Threshold")]
[HelpKeyword(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 assegnata dal valore della Type.FullName proprietà. Per i membri, la parola chiave della Guida viene assegnata dal nome completo del tipo che ha dichiarato la proprietà, oltre al nome della proprietà stessa.

Si consideri ad esempio la Control.Text proprietà nel System.Windows.Forms.Button controllo . La parola chiave class è "System.Windows.Forms.Button", ma la Control.Text parola chiave property è "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 Button.DialogResult proprietà viene dichiarata nella System.Windows.Forms.Button classe , quindi la 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. Non verrà usato per i membri del tipo in questione, che rifletterà comunque il nome completo effettivo del tipo dichiarante, più il nome del membro. Questo attributo supporta classi fortemente tipate che hanno associato documentazione comune ma ID guida distinti.