HelpKeywordAttribute Třída

Definice

Obor názvů:

System.ComponentModel.Design

Sestavení:

netstandard.dll, System.ComponentModel.TypeConverter.dll

Zdroj:

HelpKeywordAttribute.cs

Určuje kontextové klíčové slovo pro třídu nebo člena. Tuto třídu nelze zdědit.

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

Dědičnost

Object

Attribute

HelpKeywordAttribute

Atributy

AttributeUsageAttribute

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ý člen. Toto jsou klíčová slova pro následující třídu, která se nazývá 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 určení kontextové klíčové slovo. Úplné vysvětlení tohoto příkladu kódu naleznete v tématu Postupy: Použití atributů v ovládacích prvcích Windows Forms.

// 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

Poznámky

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

Představte si 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 System.Windows.Forms.Button v 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 jeho klíčové slovo je "System.Windows.Forms.Button.DialogResult".

Když systém nápovědy získá klíčová slova, bude se nejprve podívat na HelpKeywordAttribute. Na úrovni třídy vrátí řetězec určený znakem HelpKeywordAttribute. Tato možnost se nebude používat pro členy daného typu, což bude i nadá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

Name	Description
HelpKeywordAttribute()	Inicializuje novou instanci HelpKeywordAttribute třídy.
HelpKeywordAttribute(String)	Inicializuje novou instanci HelpKeywordAttribute třídy.
HelpKeywordAttribute(Type)	Inicializuje novou instanci HelpKeywordAttribute třídy z daného typu.

Pole

Name	Description
Default	Představuje výchozí hodnotu pro HelpKeywordAttribute. Toto pole je jen pro čtení.

Vlastnosti

Name	Description
HelpKeyword	Získá klíčové slovo nápovědy zadané tímto atributem.
TypeId	Při implementaci v odvozené třídě získá jedinečný identifikátor pro tento Attribute. (Zděděno od Attribute)

Metody

Name	Description
Equals(Object)	Určuje, zda jsou dvě HelpKeywordAttribute instance stejné.
GetHashCode()	Vrátí kód hash pro tuto instanci.
GetType()	Získá Type aktuální instance. (Zděděno od Object)
IsDefaultAttribute()	Určuje, zda je nullklíčové slovo nápovědy .
Match(Object)	Při přepsání v odvozené třídě vrátí hodnotu, která určuje, zda se tato instance rovná zadanému objektu. (Zděděno od Attribute)
MemberwiseClone()	Vytvoří mělkou kopii aktuálního Object. (Zděděno od Object)
ToString()	Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object)