HelpKeywordAttribute Clase

Definición

Espacio de nombres:

System.ComponentModel.Design

Ensamblados:

netstandard.dll, System.ComponentModel.TypeConverter.dll

Source:

HelpKeywordAttribute.cs

Especifica la palabra clave context para una clase o miembro. Esta clase no puede heredarse.

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

Herencia

Object

Attribute

HelpKeywordAttribute

Atributos

AttributeUsageAttribute

Ejemplos

En el ejemplo de código siguiente se muestra cómo invalidar este comportamiento del sistema de Ayuda colocando el atributo en el propio miembro. Estas son las palabras clave de la siguiente clase, denominada DemoComponent:

• Palabra clave class: "System.ComponentModel.Component" (DemoNamespace.DemoComponent)

• Palabra clave Property1: "DemoNamespace.DemoComponent.Property1" (valor predeterminado)

• Palabra clave 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 "";
        }
    }
}

En el ejemplo de código siguiente se muestra el uso de la HelpKeywordAttribute clase para especificar una palabra clave de contexto. Para obtener una explicación completa de este ejemplo de código, vea Cómo: Aplicar atributos en controles de Formularios 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

Comentarios

De forma predeterminada, el valor de la Type.FullName propiedad asigna la palabra clave Help para una clase. Para los miembros, la palabra clave Help se asigna por el nombre completo del tipo que declaró la propiedad, además del propio nombre de propiedad.

Por ejemplo, considere la Control.Text propiedad en el System.Windows.Forms.Button control . La palabra clave class es "System.Windows.Forms.Button", pero la palabra clave property Control.Text es "System.Windows.Forms.Control.Text", porque la Control.Text propiedad se declara en la System.Windows.Forms.Control clase, en lugar de la System.Windows.Forms.Button propia clase; la System.Windows.Forms.Button clase hereda la propiedad .

Por el contrario, la Button.DialogResult propiedad se declara en la System.Windows.Forms.Button clase , por lo que su palabra clave es "System.Windows.Forms.Button.DialogResult".

Cuando el sistema de ayuda obtenga las palabras clave, primero examinará HelpKeywordAttribute. En el nivel de clase, devolverá la cadena especificada por .HelpKeywordAttribute Esto no se usará para los miembros del tipo en cuestión, que seguirán reflejando el nombre completo real del tipo declarante, además del nombre del miembro. Este atributo admite clases fuertemente tipadas que tienen documentación común asociada, pero distintos identificadores de ayuda.

Constructores

Nombre	Description
HelpKeywordAttribute()	Inicializa una nueva instancia de la clase HelpKeywordAttribute.
HelpKeywordAttribute(String)	Inicializa una nueva instancia de la clase HelpKeywordAttribute.
HelpKeywordAttribute(Type)	Inicializa una nueva instancia de la HelpKeywordAttribute clase a partir del tipo especificado.

Campos

Nombre	Description
Default	Representa el valor predeterminado de HelpKeywordAttribute. Este campo es de solo lectura.

Propiedades

Nombre	Description
HelpKeyword	Obtiene la palabra clave Help proporcionada por este atributo.
TypeId	Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute. (Heredado de Attribute)

Métodos

Nombre	Description
Equals(Object)	Determina si dos HelpKeywordAttribute instancias son iguales.
GetHashCode()	Devuelve el código hash de esta instancia.
GetType()	Obtiene el Type de la instancia actual. (Heredado de Object)
IsDefaultAttribute()	Determina si la palabra clave Help es null.
Match(Object)	Cuando se reemplaza en una clase derivada, devuelve un valor que indica si esta instancia es igual a un objeto especificado. (Heredado de Attribute)
MemberwiseClone()	Crea una copia superficial del Objectactual. (Heredado de Object)
ToString()	Devuelve una cadena que representa el objeto actual. (Heredado de Object)