HelpKeywordAttribute Classe

Référence

Définition

Espace de noms:: System.ComponentModel.Design

Assembly:: System.ComponentModel.TypeConverter.dll

Assembly:: System.dll

Assembly:: netstandard.dll

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Spécifie le mot clé du contexte pour une classe ou un membre. Cette classe ne peut pas être héritée.

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

Héritage: Object

Attribute
HelpKeywordAttribute

Attributs: AttributeUsageAttribute SerializableAttribute

Exemples

L’exemple de code suivant montre comment remplacer ce comportement du système d’aide en plaçant l’attribut sur le membre lui-même. Voici les mots clés de la classe suivante, appelée DemoComponent:

Mot clé de classe : «System.ComponentModel.Component » (DemoNamespace.DemoComponent)
Mot clé Property1 : «DemoNamespace.DemoComponent.Property1 » (par défaut)
Mot clé 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 "";  
        }  
    }  
}

L’exemple de code suivant illustre l’utilisation de la HelpKeywordAttribute classe pour spécifier un mot clé de contexte. Pour obtenir une explication complète de cet exemple de code, consultez How to: Apply Attributes in Windows Forms Controls.

// 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

Remarques

Par défaut, le mot clé d’aide d’une classe est donné par la valeur de la Type.FullName propriété. Pour les membres, le mot clé d’aide est donné par le nom complet du type qui a déclaré la propriété, ainsi que le nom de propriété lui-même.

Par exemple, considérez la Control.Text propriété sur le System.Windows.Forms.Button contrôle. Le mot clé de classe est « System. Windows. Forms.Button », mais le Control.Text mot clé de propriété est « System.Windows. Forms.Control.Text », car la Control.Text propriété est déclarée sur la System.Windows.Forms.Control classe, plutôt que sur la System.Windows.Forms.Button classe elle-même; la System.Windows.Forms.Button classe hérite de la propriété.

En revanche, la Button.DialogResult propriété est déclarée sur la System.Windows.Forms.Button classe, de sorte que son mot clé est « System.Windows. Forms.Button.DialogResult ».

Lorsque le système d’aide obtient les mots clés, il examine HelpKeywordAttributed’abord . Au niveau de la classe, elle retourne la chaîne spécifiée par le HelpKeywordAttribute. Cela ne sera pas utilisé pour les membres du type en question, ce qui reflète toujours le nom complet réel du type de déclaration, ainsi que le nom du membre. Cet attribut prend en charge les classes fortement typées qui ont associé une documentation commune, mais des ID d’aide distincts.

Constructeurs

HelpKeywordAttribute()	Initialise une nouvelle instance de la classe HelpKeywordAttribute.
HelpKeywordAttribute(String)	Initialise une nouvelle instance de la classe HelpKeywordAttribute.
HelpKeywordAttribute(Type)	Initialise une nouvelle instance de la classe HelpKeywordAttribute du type donné.

Champs

Default

Représente la valeur par défaut de HelpKeywordAttribute. Ce champ est en lecture seule.

Propriétés

HelpKeyword	Obtient le mot clé d'aide fourni par cet attribut.
TypeId	Lors de l'implémentation dans une classe dérivée, obtient un identificateur unique pour l'objet Attribute. (Hérité de Attribute)

Méthodes

Equals(Object)	Détermine si deux instances HelpKeywordAttribute sont égales.
GetHashCode()	Retourne le code de hachage de cette instance.
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
IsDefaultAttribute()	Détermine si le mot clé d'aide est `null`.
Match(Object)	En cas de substitution dans une classe dérivée, retourne une valeur indiquant si cette instance équivaut à un objet spécifié. (Hérité de Attribute)
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
ToString()	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object)

Implémentations d’interfaces explicites

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Mappe un jeu de noms avec un jeu correspondant d'identificateurs de dispatch. (Hérité de Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Récupère les informations de type pour un objet, qui peuvent être utilisées pour obtenir les informations de type d'une interface. (Hérité de Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Récupère le nombre d'interfaces d'informations de type fourni par un objet (0 ou 1). (Hérité de Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Fournit l'accès aux propriétés et aux méthodes exposées par un objet. (Hérité de Attribute)

S’applique à