Este artículo se tradujo automáticamente. Para ver el artículo en inglés, active la casilla Inglés. Además, puede mostrar el texto en inglés en una ventana emergente si mueve el puntero del mouse sobre el texto.
Traducción
Inglés

Clase HelpKeywordAttribute

 

Publicado: octubre de 2016

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

Espacio de nombres:   System.ComponentModel.Design
Ensamblado:  System (en System.dll)

System.Object
  System.Attribute
    System.ComponentModel.Design.HelpKeywordAttribute

[SerializableAttribute]
[AttributeUsageAttribute(AttributeTargets.All, AllowMultiple = false, 
	Inherited = false)]
public sealed class HelpKeywordAttribute : Attribute

NombreDescripción
System_CAPS_pubmethodHelpKeywordAttribute()

Inicializa una nueva instancia de la clase HelpKeywordAttribute.

System_CAPS_pubmethodHelpKeywordAttribute(String)

Inicializa una nueva instancia de la clase HelpKeywordAttribute.

System_CAPS_pubmethodHelpKeywordAttribute(Type)

Inicializa una nueva instancia de la HelpKeywordAttribute clase a partir del tipo especificado.

NombreDescripción
System_CAPS_pubpropertyHelpKeyword

Obtiene la palabra clave de Ayuda proporciona este atributo.

System_CAPS_pubpropertyTypeId

Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute.(Heredado de Attribute).

NombreDescripción
System_CAPS_pubmethodEquals(Object)

Determina si dos instancias de HelpKeywordAttribute son iguales.(Invalida Attribute.Equals(Object)).

System_CAPS_pubmethodGetHashCode()

Devuelve el código hash de esta instancia.(Invalida Attribute.GetHashCode()).

System_CAPS_pubmethodGetType()

Obtiene el Type de la instancia actual.(Heredado de Object).

System_CAPS_pubmethodIsDefaultAttribute()

Determina si la palabra clave de ayuda es null.(Invalida Attribute.IsDefaultAttribute()).

System_CAPS_pubmethodMatch(Object)

Cuando se invalida en una clase derivada, devuelve un valor que indica si esta instancia es igual al objeto especificado. (Heredado de Attribute).

System_CAPS_pubmethodToString()

Devuelve una cadena que representa al objeto actual. (Heredado de Object).

NombreDescripción
System_CAPS_pubfieldSystem_CAPS_staticDefault

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

NombreDescripción
System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Asigna un conjunto de nombres a un conjunto correspondiente de identificadores de envío.(Heredado de Attribute).

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Obtiene la información del tipo de un objeto, que puede utilizarse para obtener la información del tipo de una interfaz. (Heredado de Attribute).

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.GetTypeInfoCount(UInt32)

Recupera el número de interfaces de tipo de información que suministra un objeto (0 ó 1)

(Heredado de Attribute).

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Proporciona acceso a las propiedades y los métodos expuestos por un objeto.(Heredado de Attribute).

De forma predeterminada, la palabra clave de ayuda para una clase viene determinada por la Type.FullName valor de propiedad. Para los miembros, palabra clave de ayuda viene determinada por el nombre completo del tipo que declara la propiedad, más el nombre de la propiedad.

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

Por el contrario, el Button.DialogResult se declara una propiedad en la System.Windows.Forms.Button clase, de manera que la palabra clave es "System.Windows.Forms.Button.DialogResult".

Cuando el sistema de ayuda Obtiene las palabras clave, buscará primero en HelpKeywordAttribute. En el nivel de clase, devolverá la cadena especificada por el HelpKeywordAttribute. No se usará para los miembros del tipo en cuestión, que seguirán reflejando nombre completo real del tipo declarativo, más el nombre de miembro. Este atributo admite clases fuertemente tipadas que hayan asociado documentación común pero distintos identificadores de ayuda.

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 para la clase siguiente, denominado DemoComponent:

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

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

  • Palabra clave de 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 cómo utilizar el HelpKeywordAttribute clase para especificar una palabra clave contextual. Para obtener una explicación completa de este ejemplo de código, consulte 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")]
[HelpKeywordAttribute(typeof(UserControl))]
[ToolboxItem("System.Windows.Forms.Design.AutoSizeToolboxItem,System.Design")]
public class AttributesDemoControl : UserControl
{

.NET Framework
Disponible desde 2.0

Cualquier miembro ( Compartido en Visual Basic) estático público de este tipo es seguro para subprocesos. No se garantiza que los miembros de instancia sean seguros para subprocesos.

Volver al principio
Mostrar: