HelpKeywordAttribute Kelas

Definisi

Ruang nama:

System.ComponentModel.Design

Rakitan:

System.ComponentModel.TypeConverter.dll

Sumber:

HelpKeywordAttribute.cs

Menentukan kata kunci konteks untuk kelas atau anggota. Kelas ini tidak dapat diwariskan.

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

Warisan

Object

Attribute

HelpKeywordAttribute

Atribut

AttributeUsageAttribute

Contoh

Contoh kode berikut menunjukkan cara mengambil alih perilaku sistem Bantuan ini dengan menempatkan atribut pada anggota itu sendiri. Ini adalah kata kunci untuk kelas berikut, yang disebut DemoComponent:

• Kata kunci kelas: "System.ComponentModel.Component" (DemoNamespace.DemoComponent)

• Kata kunci Property1: "DemoNamespace.DemoComponent.Property1" (default)

• Kata kunci 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 "";  
        }  
    }  
}  

Contoh kode berikut menunjukkan penggunaan HelpKeywordAttribute kelas untuk menentukan kata kunci konteks. Untuk penjelasan lengkap tentang contoh kode ini, lihat Cara: Menerapkan Atribut di kontrol Formulir Windows.

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

Keterangan

Secara default, kata kunci Bantuan untuk kelas diberikan oleh Type.FullName nilai properti. Untuk anggota, kata kunci Bantuan diberikan dengan nama lengkap jenis yang mendeklarasikan properti , ditambah nama properti itu sendiri.

Misalnya, pertimbangkan Control.Text properti pada System.Windows.Forms.Button kontrol. Kata kunci kelas adalah "System.Windows. Forms. Tombol", tetapi Control.Text kata kunci properti adalah "System.Windows.Forms. Control.Text", karena Control.Text properti dideklarasikan pada System.Windows.Forms.Control kelas , bukan kelas itu System.Windows.Forms.ButtonSystem.Windows.Forms.Button sendiri; kelas mewarisi properti .

Sebaliknya, Button.DialogResult properti dideklarasikan pada System.Windows.Forms.Button kelas , jadi kata kuncinya adalah "System.Windows.Forms. Button.DialogResult".

Ketika sistem Bantuan mendapatkan kata kunci, pertama-tama akan melihat HelpKeywordAttribute. Pada tingkat kelas, itu akan mengembalikan string yang ditentukan oleh HelpKeywordAttribute. Ini tidak akan digunakan untuk anggota jenis yang dimaksud, yang masih akan mencerminkan nama lengkap aktual jenis deklarasikan, ditambah nama anggota. Atribut ini mendukung kelas dengan jenis kuat yang memiliki dokumentasi umum terkait tetapi ID Bantuan yang berbeda.

Konstruktor

HelpKeywordAttribute()	Menginisialisasi instans baru kelas HelpKeywordAttribute.
HelpKeywordAttribute(String)	Menginisialisasi instans baru kelas HelpKeywordAttribute.
HelpKeywordAttribute(Type)	Menginisialisasi instans HelpKeywordAttribute baru kelas dari jenis yang diberikan.

Bidang

Default

Mewakili nilai default untuk HelpKeywordAttribute. Bidang ini hanya-baca.

Properti

HelpKeyword	Mendapatkan kata kunci Bantuan yang disediakan oleh atribut ini.
TypeId	Ketika diimplementasikan di kelas turunan, mendapatkan pengidentifikasi unik untuk ini Attribute. (Diperoleh dari Attribute)

Metode

Equals(Object)	Menentukan apakah dua HelpKeywordAttribute instans sama.
GetHashCode()	Mengembalikan kode hash untuk instans ini.
GetType()	Mendapatkan dari instans Type saat ini. (Diperoleh dari Object)
IsDefaultAttribute()	Menentukan apakah kata kunci Bantuan adalah null.
Match(Object)	Saat ditimpa di kelas turunan, mengembalikan nilai yang menunjukkan apakah instans ini sama dengan objek tertentu. (Diperoleh dari Attribute)
MemberwiseClone()	Membuat salinan dangkal dari saat ini Object. (Diperoleh dari Object)
ToString()	Mengembalikan string yang mewakili objek saat ini. (Diperoleh dari Object)