HelpKeywordAttribute HelpKeywordAttribute HelpKeywordAttribute HelpKeywordAttribute Class

Определение

Указывает ключевое слово контекста для класса или члена.Specifies the context keyword for a class or member. Этот класс не наследуется.This class cannot be inherited.

public ref class HelpKeywordAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.All, AllowMultiple=false, Inherited=false)]
[System.Serializable]
public sealed class HelpKeywordAttribute : Attribute
type HelpKeywordAttribute = class
    inherit Attribute
Public NotInheritable Class HelpKeywordAttribute
Inherits Attribute
Наследование
HelpKeywordAttributeHelpKeywordAttributeHelpKeywordAttributeHelpKeywordAttribute
Атрибуты

Примеры

В следующем примере кода показано, как переопределить это поведение системы справки, разместив атрибут в сам элемент.The following code example shows how to override this Help system behavior by placing the attribute on the member itself. Ниже приведены ключевые слова для следующего класса под названием DemoComponent:These are the keywords for the following class, called DemoComponent:

  • Ключевое слово class: "System.ComponentModel.Component" (DemoNamespace.DemoComponent)Class keyword: "System.ComponentModel.Component" (DemoNamespace.DemoComponent)

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

  • Ключевое слово свойство2: "SomeNamespace.SomeOtherClass.Property2" (DemoNamespace.DemoComponent.Property2)Property2 keyword: "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 класс, чтобы указать ключевое слово контекста.The following code example demonstrates using the HelpKeywordAttribute class to specify a context keyword. Полное описание этого примера кода, см. в разделе как: Применение атрибутов в элементах управления Windows Forms.For a complete explanation of this code example, see How to: Apply Attributes in Windows Forms Controls.

// 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 значение свойства.By default, the Help keyword for a class is given by the Type.FullName property value. Для членов ключевое слово справки, указывает полное имя типа, объявленные свойства, а также само имя свойства.For members, the Help keyword is given by the full name of the type that declared the property, plus the property name itself.

Например, рассмотрим Control.Text свойство System.Windows.Forms.Button элемента управления.For example, consider the Control.Text property on the System.Windows.Forms.Button control. Class-ключевое слово является «System.Windows.Forms.Button», но Control.Text property-ключевое слово является «System.Windows.Forms.Control.Text», так как Control.Text объявлено это свойство System.Windows.Forms.Control класса, а не System.Windows.Forms.Button сам по себе класс ; System.Windows.Forms.Button класс наследует свойство.The class keyword is "System.Windows.Forms.Button", but the Control.Text property keyword is "System.Windows.Forms.Control.Text", because the Control.Text property is declared on the System.Windows.Forms.Control class, rather than the System.Windows.Forms.Button class itself; the System.Windows.Forms.Button class inherits the property.

Напротив Button.DialogResult объявлено это свойство System.Windows.Forms.Button класса, поэтому ключевое слово «System.Windows.Forms.Button.DialogResult».By contrast, the Button.DialogResult property is declared on the System.Windows.Forms.Button class, so its keyword is "System.Windows.Forms.Button.DialogResult".

Когда справочная система получает ключевые слова, он сначала посмотрим HelpKeywordAttribute.When the Help system gets the keywords, it will first look at HelpKeywordAttribute. На уровне класса, будет возвращена строка, заданная HelpKeywordAttribute.At the class level, it will return the string specified by the HelpKeywordAttribute. Это не будет использоваться членами типа, который по-прежнему будет отражать фактическое полное имя объявляющего типа, а также имя члена.This will not be used for members of the type in question, which will still reflect the declaring type's actual full name, plus the member name. Этот атрибут поддерживает строго типизированных классов, с которыми связаны общую документацию за исключением отдельных идентификаторов справки.This attribute supports strongly typed classes that have associated common documentation but distinct Help IDs.

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

HelpKeywordAttribute() HelpKeywordAttribute() HelpKeywordAttribute() HelpKeywordAttribute()

Инициализирует новый экземпляр класса HelpKeywordAttribute.Initializes a new instance of the HelpKeywordAttribute class.

HelpKeywordAttribute(String) HelpKeywordAttribute(String) HelpKeywordAttribute(String) HelpKeywordAttribute(String)

Инициализирует новый экземпляр класса HelpKeywordAttribute.Initializes a new instance of the HelpKeywordAttribute class.

HelpKeywordAttribute(Type) HelpKeywordAttribute(Type) HelpKeywordAttribute(Type) HelpKeywordAttribute(Type)

Выполняет инициализацию нового экземпляра класса HelpKeywordAttribute на основе заданного типа.Initializes a new instance of the HelpKeywordAttribute class from the given type.

Поля

Default Default Default Default

Представляет значение по умолчанию для объекта HelpKeywordAttribute.Represents the default value for HelpKeywordAttribute. Это поле доступно только для чтения.This field is read-only.

Свойства

HelpKeyword HelpKeyword HelpKeyword HelpKeyword

Возвращает ключевое слово справки, предоставленное в данном атрибуте.Gets the Help keyword supplied by this attribute.

TypeId TypeId TypeId TypeId

При реализации в производном классе возвращает уникальный идентификатор для этого Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Методы

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Определяет, равны ли два экземпляра HelpKeywordAttribute.Determines whether two HelpKeywordAttribute instances are equal.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Возвращает хэш-код данного экземпляра.Returns the hash code for this instance.

GetType() GetType() GetType() GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute()

Определяет, имеет ли ключевое слово справки значение null.Determines whether the Help keyword is null.

Match(Object) Match(Object) Match(Object) Match(Object)

При переопределении в производном классе возвращает значение, указывающее, является ли этот экземпляр равным заданному объекту.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Inherited from Object)

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

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Сопоставляет набор имен соответствующему набору идентификаторов диспетчеризации.Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Возвращает сведения о типе объекта, которые могут использоваться для получения сведений о типе интерфейса.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32)

Возвращает количество предоставляемых объектом интерфейсов для доступа к сведениям о типе (0 или 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Предоставляет доступ к открытым свойствам и методам объекта.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

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