HelpKeywordAttribute Osztály

Definíció

Névtér:

System.ComponentModel.Design

Szerelvények:

netstandard.dll, System.ComponentModel.TypeConverter.dll

Forrás:

HelpKeywordAttribute.cs

Egy osztály vagy tag környezeti kulcsszóját adja meg. Ez az osztály nem örökölhető.

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

Öröklődés

Object

Attribute

HelpKeywordAttribute

Attribútumok

AttributeUsageAttribute

Példák

Az alábbi példakód bemutatja, hogyan bírálhatja felül ezt a súgórendszer-viselkedést úgy, hogy az attribútumot maga a tagra helyezi. Ezek a kulcsszavak a következő osztály, az úgynevezett DemoComponent:

• Osztály kulcsszó: "System.ComponentModel.Component" (DemoNamespace.DemoComponent)

• Property1 kulcsszó: "DemoNamespace.DemoComponent.Property1" (alapértelmezett)

• Property2 kulcsszó: "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 "";
        }
    }
}

Az alábbi példakód bemutatja, hogy az HelpKeywordAttribute osztály használatával határoz meg egy környezeti kulcsszót. A példakód teljes ismertetését a Az attribútumok alkalmazása Windows Forms vezérlőkben című témakörben találhatja meg.

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

Megjegyzések

Alapértelmezés szerint az osztály súgó kulcsszóját a Type.FullName tulajdonság értéke adja meg. A tagok esetében a súgó kulcsszót a tulajdonságot deklarált típus teljes neve, valamint magát a tulajdonságnevet adja meg.

Vegyük például a Control.Text vezérlőelem System.Windows.Forms.Button tulajdonságát. Az osztály kulcsszó: "Rendszer. Windows. Forms.Button", de a Control.Text tulajdonság kulcsszó a "System. Windows. Forms.Control.Text", mivel a Control.Text tulajdonság a System.Windows.Forms.Control osztályon van deklarálva, nem pedig magának a System.Windows.Forms.Button osztálynak; a System.Windows.Forms.Button osztály örökli a tulajdonságot.

Ezzel szemben a Button.DialogResult tulajdonság deklarálva van a System.Windows.Forms.Button osztályban, így a kulcsszó a "System. Windows. Forms.Button.DialogResult".

Amikor a súgórendszer lekéri a kulcsszavakat, először megtekinti HelpKeywordAttribute. Az osztály szintjén a függvény a megadott sztringet adja vissza.HelpKeywordAttribute Ez nem használható a szóban forgó típus tagjai számára, amely továbbra is tükrözi a deklarálási típus tényleges teljes nevét, valamint a tag nevét. Ez az attribútum olyan erősen gépelt osztályokat támogat, amelyek közös dokumentációval, de különálló súgóazonosítókkal rendelkeznek.

Konstruktorok

Name	Description
HelpKeywordAttribute()	Inicializálja a HelpKeywordAttribute osztály új példányát.
HelpKeywordAttribute(String)	Inicializálja a HelpKeywordAttribute osztály új példányát.
HelpKeywordAttribute(Type)	Inicializálja az osztály új példányát az HelpKeywordAttribute adott típusból.

Mezők

Name	Description
Default	A alapértelmezett értékét HelpKeywordAttributejelöli. Ez a mező csak olvasható.

Tulajdonságok

Name	Description
HelpKeyword	Lekéri az attribútum által megadott súgó kulcsszót.
TypeId	Ha származtatott osztályban implementálják, ehhez egy egyedi azonosítót Attributekap. (Öröklődés forrása Attribute)

Metódusok

Name	Description
Equals(Object)	Meghatározza, hogy két HelpKeywordAttribute példány egyenlő-e.
GetHashCode()	A példány kivonatkódját adja vissza.
GetType()	Lekéri az Type aktuális példányt. (Öröklődés forrása Object)
IsDefaultAttribute()	Meghatározza, hogy a súgó kulcsszó a nullkövetkező-e.
Match(Object)	Származtatott osztály felülírásakor egy olyan értéket ad vissza, amely jelzi, hogy ez a példány egy adott objektummal egyenlő-e. (Öröklődés forrása Attribute)
MemberwiseClone()	Az aktuális Objectpéldány sekély másolatát hozza létre. (Öröklődés forrása Object)
ToString()	Az aktuális objektumot jelképező sztringet ad vissza. (Öröklődés forrása Object)