HelpKeywordAttribute Klasa

Definicja

Przestrzeń nazw:

System.ComponentModel.Design

Zestaw:

System.ComponentModel.TypeConverter.dll

Źródło:

HelpKeywordAttribute.cs

Określa słowo kluczowe kontekstu dla klasy lub składowej. Klasa ta nie może być dziedziczona.

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

Dziedziczenie

Object

Attribute

HelpKeywordAttribute

Atrybuty

AttributeUsageAttribute

Przykłady

Poniższy przykład kodu pokazuje, jak zastąpić to zachowanie systemu Pomocy przez umieszczenie atrybutu na samym elemencie członkowskim. Są to słowa kluczowe dla następującej klasy o nazwie DemoComponent:

• Słowo kluczowe klasy: "System.ComponentModel.Component" (DemoNamespace.DemoComponent)

• Słowo kluczowe Property1: "DemoNamespace.DemoComponent.Property1" (ustawienie domyślne)

• Słowo kluczowe 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 "";  
        }  
    }  
}  

W poniższym przykładzie kodu pokazano użycie HelpKeywordAttribute klasy do określenia słowa kluczowego kontekstu. Pełny opis tego przykładu kodu można znaleźć w temacie How to: Apply Attributes in Windows Forms Controls (Instrukcje: stosowanie atrybutów w kontrolkach 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

Uwagi

Domyślnie słowo kluczowe Pomocy dla klasy jest podane przez Type.FullName wartość właściwości. W przypadku elementów członkowskich słowo kluczowe Help jest podane przez pełną nazwę typu, który zadeklarował właściwość, oraz samą nazwę właściwości.

Rozważmy na przykład Control.Text właściwość kontrolki System.Windows.Forms.Button . Słowo kluczowe klasy to "System.Windows. Forms. Button", ale Control.Text słowo kluczowe właściwości to "System.Windows.Forms. Control.Text", ponieważ Control.Text właściwość jest zadeklarowana w System.Windows.Forms.Control klasie, a nie System.Windows.Forms.Button w samej klasie, System.Windows.Forms.Button klasa dziedziczy właściwość .

Button.DialogResult Natomiast właściwość jest zadeklarowana w System.Windows.Forms.Button klasie, więc jej słowo kluczowe to "System.Windows.Forms. Button.DialogResult".

Gdy system Pomocy pobiera słowa kluczowe, najpierw przyjrzy się .HelpKeywordAttribute Na poziomie klasy zwróci on ciąg określony przez element HelpKeywordAttribute. Nie będzie to używane w przypadku elementów członkowskich danego typu, co nadal będzie odzwierciedlać rzeczywistą pełną nazwę typu deklarowanego oraz nazwę elementu członkowskiego. Ten atrybut obsługuje silnie typizowane klasy, które mają skojarzona wspólną dokumentację, ale odrębne identyfikatory Pomocy.

Konstruktory

HelpKeywordAttribute()	Inicjuje nowe wystąpienie klasy HelpKeywordAttribute.
HelpKeywordAttribute(String)	Inicjuje nowe wystąpienie klasy HelpKeywordAttribute.
HelpKeywordAttribute(Type)	Inicjuje HelpKeywordAttribute nowe wystąpienie klasy z danego typu.

Pola

Default

Reprezentuje wartość domyślną dla .HelpKeywordAttribute To pole jest tylko do odczytu.

Właściwości

HelpKeyword	Pobiera słowo kluczowe Help dostarczone przez ten atrybut.
TypeId	Po zaimplementowaniu w klasie pochodnej pobiera unikatowy identyfikator dla tego Attributeelementu . (Odziedziczone po Attribute)

Metody

Equals(Object)	Określa, czy dwa HelpKeywordAttribute wystąpienia są równe.
GetHashCode()	Zwraca wartość skrótu dla tego wystąpienia.
GetType()	Type Pobiera wartość bieżącego wystąpienia. (Odziedziczone po Object)
IsDefaultAttribute()	Określa, czy słowo kluczowe Help to null.
Match(Object)	Po przesłonięciu w klasie pochodnej zwraca wartość wskazującą, czy to wystąpienie jest równe określonemu obiektowi. (Odziedziczone po Attribute)
MemberwiseClone()	Tworzy płytkią kopię bieżącego Objectelementu . (Odziedziczone po Object)
ToString()	Zwraca ciąg reprezentujący bieżący obiekt. (Odziedziczone po Object)