HelpKeywordAttribute Classe

Definição

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

Herança

Object

Attribute

HelpKeywordAttribute

Atributos

AttributeUsageAttribute SerializableAttribute

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 da seguinte classe, chamada DemoComponent:

• Palavra-chave de classe: "System.ComponentModel.Component" (DemoNamespace.DemoComponent)

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

• Palavra-chave 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 "";
        }
    }
}

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

Comentários

Por padrão, a palavra-chave da Ajuda para uma classe é fornecida pelo valor da Type.FullName propriedade. Para membros, a palavra-chave 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 palavra-chave de classe é "System.Windows.Forms.Button", mas a palavra-chave da Control.Text propriedade é "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, ela 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 de declaração, 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.