HelpKeywordAttribute Класс

Определение

Пространство имен:

System.ComponentModel.Design

Сборка:

System.ComponentModel.TypeConverter.dll

Исходный код:

HelpKeywordAttribute.cs

Указывает ключевое слово контекста для класса или элемента. Этот класс не наследуется.

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

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

Object

Attribute

HelpKeywordAttribute

Атрибуты

AttributeUsageAttribute

Примеры

В следующем примере кода показано, как переопределить поведение системы справки, разместив атрибут в самом элементе. Это ключевые слова для следующего класса с именем 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")]
[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

Комментарии

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

Например, рассмотрим Control.Text свойство элемента System.Windows.Forms.Button управления . Класс ключевое слово — System.Windows.Forms. Кнопка", но 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. Он не будет использоваться для членов рассматриваемого типа, которые по-прежнему будут отражать фактическое полное имя объявляющего типа, а также имя члена. Этот атрибут поддерживает строго типизированные классы, имеющие связанную общую документацию, но разные идентификаторы справки.

Конструкторы

HelpKeywordAttribute()	Инициализирует новый экземпляр класса HelpKeywordAttribute.
HelpKeywordAttribute(String)	Инициализирует новый экземпляр класса HelpKeywordAttribute.
HelpKeywordAttribute(Type)	Выполняет инициализацию нового экземпляра класса HelpKeywordAttribute на основе заданного типа.

Поля

Default

Представляет значение по умолчанию для объекта HelpKeywordAttribute. Это поле доступно только для чтения.

Свойства

HelpKeyword	Возвращает ключевое слово справки, указанное этим атрибутом.
TypeId	В случае реализации в производном классе возвращает уникальный идентификатор для этого атрибута Attribute. (Унаследовано от Attribute)

Методы

Equals(Object)	Определяет, равны ли два экземпляра HelpKeywordAttribute.
GetHashCode()	Возвращает хэш-код данного экземпляра.
GetType()	Возвращает объект Type для текущего экземпляра. (Унаследовано от Object)
IsDefaultAttribute()	Определяет, имеет ли ключевое слово справки значение null.
Match(Object)	При переопределении в производном классе возвращает значение, указывающее, является ли этот экземпляр равным заданному объекту. (Унаследовано от Attribute)
MemberwiseClone()	Создает неполную копию текущего объекта Object. (Унаследовано от Object)
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)