HelpKeywordAttribute Classe

Definição

public ref class HelpKeywordAttribute sealed : 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)]
public sealed class HelpKeywordAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.All, AllowMultiple=false, Inherited=false)>]
[<System.Serializable>]
type HelpKeywordAttribute = class
    inherit 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 SerializableAttribute

Exemplos

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

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

• Palavra-chave Property1: "DemoNamespace.DemoComponent.Property1" (por defeito)

• 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 seguinte demonstra o uso da HelpKeywordAttribute classe para especificar uma palavra-chave de contexto. Para uma explicação completa deste exemplo de código, veja Como: Aplicar Atributos em Controlos 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

Observações

Por defeito, a palavra-chave Ajuda para uma classe é dada pelo valor da Type.FullName propriedade. Para os membros, a palavra-chave Ajuda é dada pelo nome completo do tipo que declarou a propriedade, mais o próprio nome da propriedade.

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

Em contraste, a propriedade Button.DialogResult é declarada na classe System.Windows.Forms.Button, pelo que a sua palavra-chave é "System. Windows. Forms.Button.DialogResult".

Quando o sistema de Ajuda recebe as palavras-chave, irá primeiro analisar HelpKeywordAttribute. Ao nível da classe, devolverá a cadeia especificada pelo HelpKeywordAttribute. Esta não será usada para membros do tipo em questão, que continuarão a refletir o nome completo real do tipo declarante, mais o nome do membro. Este atributo suporta classes fortemente tipadas que têm documentação comum associada, mas IDs de Ajuda distintos.