HelpKeywordAttribute Třída

Definice

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

Dědičnost

Object

Attribute

HelpKeywordAttribute

Atributy

AttributeUsageAttribute SerializableAttribute

Příklady

Následující příklad kódu ukazuje, jak přepsat toto chování systému nápovědy umístěním atributu na samotného člena. Toto jsou klíčová slova pro následující třídu s názvem DemoComponent:

• Klíčové slovo třídy: "System.ComponentModel.Component" (DemoNamespace.DemoComponent)

• Klíčové slovo Property1: "DemoNamespace.DemoComponent.Property1" (výchozí)

• Klíčové slovo 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 "";  
        }  
    }  
}  

Následující příklad kódu ukazuje použití HelpKeywordAttribute třídy k zadání kontextového klíčového slova. Úplné vysvětlení tohoto příkladu kódu najdete v tématu Postupy: Použití atributů v ovládacích prvcích model 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

Poznámky

Ve výchozím nastavení je klíčové slovo Help pro třídu dáno Type.FullName hodnotou vlastnosti. U členů je klíčové slovo nápovědy dáno úplným názvem typu, který deklaroval vlastnost, a názvem samotné vlastnosti.

Zvažte Control.Text například vlastnost System.Windows.Forms.Button ovládacího prvku. Klíčové slovo třídy je System.Windows. Forms. Button, ale Control.Text klíčové slovo vlastnosti je System.Windows.Forms. Control.Text", protože Control.Text vlastnost je deklarována ve System.Windows.Forms.Control třídě, nikoli v System.Windows.Forms.Button samotné třídě; System.Windows.Forms.Button třída dědí vlastnost.

Naproti tomu Button.DialogResult vlastnost je deklarována ve System.Windows.Forms.Button třídě, takže její klíčové slovo je "System.Windows.Forms. Button.DialogResult".

Když systém nápovědy získá klíčová slova, nejprve se podívá na HelpKeywordAttribute. Na úrovni třídy vrátí řetězec určený parametrem HelpKeywordAttribute. Tato možnost nebude použita pro členy příslušného typu, což bude stále odrážet skutečné celé jméno deklarujícího typu a jméno člena. Tento atribut podporuje třídy silného typu, které mají přidruženou společnou dokumentaci, ale jedinečná ID nápovědy.

Konstruktory

Pole

Vlastnosti

Metody

Explicitní implementace rozhraní

Platí pro