HelpKeywordAttribute Класс

Определение

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)]
[System.Serializable]
public sealed class HelpKeywordAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.All, AllowMultiple=false, Inherited=false)>]
type HelpKeywordAttribute = class
    inherit Attribute

[<System.AttributeUsage(System.AttributeTargets.All, AllowMultiple=false, Inherited=false)>]
[<System.Serializable>]
type HelpKeywordAttribute = class
    inherit Attribute

Public NotInheritable Class HelpKeywordAttribute
Inherits Attribute

Наследование

Object

Attribute

HelpKeywordAttribute

Атрибуты

AttributeUsageAttribute SerializableAttribute

Примеры

В следующем примере кода показано, как переопределить поведение системы справки путем размещения атрибута на самом элементе. Это ключевые слова для следующего класса:DemoComponent

• Ключевое слово класса: "System.ComponentModel.Component" (DemoNamespace.DemoComponent)

• Ключевое слово Property1: "DemoNamespace.DemoComponent.Property1" (по умолчанию)

• Ключевое слово 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 "";
        }
    }
}

В следующем примере кода показано использование HelpKeywordAttribute класса для указания ключевого слова контекста. Полное описание этого примера кода см. в статье "Практическое руководство. Применение атрибутов в элементах управления 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

Комментарии

По умолчанию ключевое слово help для класса присваивается значением Type.FullName свойства. Для членов ключевое слово справки присваивается полное имя типа, объявленного свойством, а также само имя свойства.

Например, рассмотрим Control.Text свойство элемента System.Windows.Forms.Button управления. Ключевое слово класса — System.Windows.Forms.Button, но Control.Text ключевое слово свойства — System.Windows.Forms.Control.Text, так как Control.Text свойство объявляется в System.Windows.Forms.Control классе, а не System.Windows.Forms.Button самом классе, System.Windows.Forms.Button а класс наследует свойство.

Напротив, Button.DialogResult свойство объявляется в System.Windows.Forms.Button классе, поэтому его ключевое слово — System.Windows.Forms.Button.DialogResult.

Когда система справки получает ключевые слова, сначала будет рассматриваться HelpKeywordAttribute. На уровне класса он вернет строку, указанную в параметре HelpKeywordAttribute. Это не будет использоваться для членов указанного типа, что по-прежнему отражает фактическое полное имя типа объявления, а также имя члена. Этот атрибут поддерживает строго типизированные классы, связанные с общей документацией, но уникальные идентификаторы справки.