HelpKeywordAttribute Sınıf

Tanım

Ad Alanı:

System.ComponentModel.Design

Bütünleştirilmiş Kodlar:

netstandard.dll, System.ComponentModel.TypeConverter.dll

Kaynak:

HelpKeywordAttribute.cs

Bir sınıf veya üye için bağlam anahtar sözcüğünü belirtir. Bu sınıf devralınamaz.

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

Devralma

Object

Attribute

HelpKeywordAttribute

Öznitelikler

AttributeUsageAttribute

Örnekler

Aşağıdaki kod örneğinde, özniteliği üyenin kendisine yerleştirerek bu Yardım sistemi davranışının nasıl geçersiz kılındığı gösterilmektedir. Aşağıdaki sınıfın anahtar sözcükleri şunlardır:DemoComponent

• Sınıf anahtar sözcüğü: "System.ComponentModel.Component" (DemoNamespace.DemoComponent)

• Property1 anahtar sözcüğü: "DemoNamespace.DemoComponent.Property1" (varsayılan)

• Property2 anahtar sözcüğü: "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 "";
        }
    }
}

Aşağıdaki kod örneği, bağlam anahtar sözcüğü belirtmek için sınıfının kullanılmasını HelpKeywordAttribute gösterir. Bu kod örneğinin tam açıklaması için bkz . Nasıl yapılır: Windows Forms Denetimlerinde Öznitelikleri Uygulama.

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

Açıklamalar

Varsayılan olarak, bir sınıfın Help anahtar sözcüğü özellik değeri tarafından Type.FullName verilir. Üyeler için Help anahtar sözcüğü, özelliği bildiren türün tam adı ve özellik adının kendisi tarafından verilir.

Örneğin, denetimindeki Control.TextSystem.Windows.Forms.Button özelliğini göz önünde bulundurun. Sınıf anahtar sözcüğü "System.Windows.Forms.Button" şeklindedir, ancak Control.Text özellik anahtar sözcüğü "System.Windows.Forms.Control.Text" şeklindedir, çünkü Control.Text özellik sınıfın kendisi yerine System.Windows.Forms.Button sınıfında bildirilirSystem.Windows.Forms.Control; System.Windows.Forms.Button sınıf özelliği devralır.

Buna karşılık, Button.DialogResult özelliği sınıfında bildirilir System.Windows.Forms.Button , bu nedenle anahtar sözcüğü "System.Windows.Forms.Button.DialogResult" olur.

Yardım sistemi anahtar sözcükleri aldığında ilk olarak öğesine bakar HelpKeywordAttribute. Sınıf düzeyinde, tarafından belirtilen dizeyi HelpKeywordAttributedöndürür. Bu, söz konusu türün üyeleri için kullanılmayacak ve bu da bildirimde bulunan türün gerçek tam adını ve üye adını yansıtmaya devam edecektir. Bu öznitelik, ortak belgelerle ilişkili ancak farklı Yardım kimliklerine sahip, kesin olarak yazılan sınıfları destekler.

Oluşturucular

Name	Description
HelpKeywordAttribute()	HelpKeywordAttribute sınıfının yeni bir örneğini başlatır.
HelpKeywordAttribute(String)	HelpKeywordAttribute sınıfının yeni bir örneğini başlatır.
HelpKeywordAttribute(Type)	Verilen türden sınıfın HelpKeywordAttribute yeni bir örneğini başlatır.

Alanlar

Name	Description
Default	için HelpKeywordAttributevarsayılan değeri temsil eder. Bu alan salt okunurdur.

Özellikler

Name	Description
HelpKeyword	Bu öznitelik tarafından sağlanan Yardım anahtar sözcüğünü alır.
TypeId	Türetilmiş bir sınıfta uygulandığında, bu Attributeiçin benzersiz bir tanımlayıcı alır. (Devralındığı yer: Attribute)

Yöntemler

Name	Description
Equals(Object)	İki HelpKeywordAttribute örneğin eşit olup olmadığını belirler.
GetHashCode()	Bu örneğin karma kodunu döndürür.
GetType()	Geçerli örneğin Type alır. (Devralındığı yer: Object)
IsDefaultAttribute()	Help anahtar sözcüğünü nullolup olmadığını belirler.
Match(Object)	Türetilmiş bir sınıfta geçersiz kılındığında, bu örneğin belirtilen bir nesneye eşit olup olmadığını gösteren bir değer döndürür. (Devralındığı yer: Attribute)
MemberwiseClone()	Geçerli Objectbasit bir kopyasını oluşturur. (Devralındığı yer: Object)
ToString()	Geçerli nesneyi temsil eden bir dize döndürür. (Devralındığı yer: Object)