HelpKeywordAttribute Класс

Ссылка

Определение

Пространство имен:: System.ComponentModel.Design

Сборка:: System.ComponentModel.TypeConverter.dll

Сборка:: System.dll

Сборка:: netstandard.dll

Важно!

Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.

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

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")]
[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

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

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

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

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)

Явные реализации интерфейса

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Сопоставляет набор имен соответствующему набору идентификаторов диспетчеризации. (Унаследовано от Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Возвращает сведения о типе объекта, которые можно использовать для получения сведений о типе интерфейса. (Унаследовано от Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Возвращает количество предоставляемых объектом интерфейсов для доступа к сведениям о типе (0 или 1). (Унаследовано от Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Предоставляет доступ к открытым свойствам и методам объекта. (Унаследовано от Attribute)

Применяется к