HelpKeywordAttribute Classe

Definição

Namespace:

System.ComponentModel.Design

Assembly:

System.ComponentModel.TypeConverter.dll

Origem:

HelpKeywordAttribute.cs

Especifica a palavra-chave de contexto para uma classe ou membro. Essa classe não pode ser herdada.

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

Herança

Object

Attribute

HelpKeywordAttribute

Atributos

AttributeUsageAttribute

Exemplos

O exemplo de código a seguir mostra como substituir esse comportamento do sistema de Ajuda colocando o atributo no próprio membro. Estas são as palavras-chave para a seguinte classe, chamada DemoComponent:

• Classe palavra-chave: "System.ComponentModel.Component" (DemoNamespace.DemoComponent)

• Property1 palavra-chave: "DemoNamespace.DemoComponent.Property1" (padrão)

• Property2 palavra-chave: "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 "";  
        }  
    }  
}  

O exemplo de código a seguir demonstra o uso da HelpKeywordAttribute classe para especificar um contexto palavra-chave. Para obter uma explicação completa desse exemplo de código, consulte Como aplicar atributos em controles de 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

Comentários

Por padrão, a ajuda palavra-chave para uma classe é fornecida pelo valor da Type.FullName propriedade. Para membros, a palavra-chave de Ajuda é fornecida pelo nome completo do tipo que declarou a propriedade, além do próprio nome da propriedade.

Por exemplo, considere a Control.Text propriedade no System.Windows.Forms.Button controle . A classe palavra-chave é "System.Windows.Forms. Botão", mas a Control.Text propriedade palavra-chave é "System.Windows.Forms. Control.Text", porque a Control.Text propriedade é declarada na System.Windows.Forms.Control classe , em vez da System.Windows.Forms.Button própria classe; a System.Windows.Forms.Button classe herda a propriedade .

Por outro lado, a Button.DialogResult propriedade é declarada na System.Windows.Forms.Button classe , portanto, sua palavra-chave é "System.Windows.Forms. Button.DialogResult".

Quando o sistema de Ajuda obtém as palavras-chave, ele primeiro examinará HelpKeywordAttribute. No nível da classe, ele retornará a cadeia de caracteres especificada pelo HelpKeywordAttribute. Isso não será usado para membros do tipo em questão, o que ainda refletirá o nome completo real do tipo declarador, além do nome do membro. Esse atributo dá suporte a classes fortemente tipdas que têm documentação comum associada, mas IDs de Ajuda distintas.

Construtores

HelpKeywordAttribute()	Inicializa uma nova instância da classe HelpKeywordAttribute.
HelpKeywordAttribute(String)	Inicializa uma nova instância da classe HelpKeywordAttribute.
HelpKeywordAttribute(Type)	Inicializa uma nova instância da classe HelpKeywordAttribute do tipo fornecido.

Campos

Default

Representa o valor padrão para HelpKeywordAttribute. Este campo é somente leitura.

Propriedades

HelpKeyword	Obtém a palavra-chave da Ajuda fornecida por este atributo.
TypeId	Quando implementado em uma classe derivada, obtém um identificador exclusivo para este Attribute. (Herdado de Attribute)

Métodos

Equals(Object)	Determina se duas instâncias HelpKeywordAttribute são iguais.
GetHashCode()	Retorna o código hash para a instância.
GetType()	Obtém o Type da instância atual. (Herdado de Object)
IsDefaultAttribute()	Determina se a palavra-chave da Ajuda é null.
Match(Object)	Quando substituído em uma classe derivada, retorna um valor que indica se essa instância é igual a um objeto especificado. (Herdado de Attribute)
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object)