CallerMemberNameAttribute Classe

Définition

Espace de noms:

System.Runtime.CompilerServices

Assembly:

System.Runtime.dll

Source:

CallerMemberNameAttribute.cs

Permet d'obtenir le nom de méthode ou de propriété de l'appelant de la méthode.

public ref class CallerMemberNameAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Parameter, Inherited=false)]
public sealed class CallerMemberNameAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Parameter, Inherited=false)>]
type CallerMemberNameAttribute = class
    inherit Attribute

Public NotInheritable Class CallerMemberNameAttribute
Inherits Attribute

Héritage

Object

Attribute

CallerMemberNameAttribute

Attributs

AttributeUsageAttribute

Exemples

L'exemple suivant montre comment utiliser l'attribut CallerMemberName. À chaque appel à la TraceMessage méthode, les informations de l’appelant sont substituées en tant qu’argument au paramètre facultatif.

public void DoProcessing()
{
    TraceMessage("Something happened.");
}

public void TraceMessage(string message,
        [System.Runtime.CompilerServices.CallerMemberName] string memberName = "",
        [System.Runtime.CompilerServices.CallerFilePath] string sourceFilePath = "",
        [System.Runtime.CompilerServices.CallerLineNumber] int sourceLineNumber = 0)
{
    System.Diagnostics.Trace.WriteLine("message: " + message);
    System.Diagnostics.Trace.WriteLine("member name: " + memberName);
    System.Diagnostics.Trace.WriteLine("source file path: " + sourceFilePath);
    System.Diagnostics.Trace.WriteLine("source line number: " + sourceLineNumber);
}

// Sample Output:
//  message: Something happened.
//  member name: DoProcessing
//  source file path: c:\Users\username\Documents\Visual Studio 2012\Projects\CallerInfoCS\CallerInfoCS\Form1.cs
//  source line number: 31

Private Sub DoProcessing()
    TraceMessage("Something happened.")
End Sub

Public Sub TraceMessage(message As String,
        <System.Runtime.CompilerServices.CallerMemberName> Optional memberName As String = Nothing,
        <System.Runtime.CompilerServices.CallerFilePath> Optional sourcefilePath As String = Nothing,
        <System.Runtime.CompilerServices.CallerLineNumber()> Optional sourceLineNumber As Integer = 0)

    System.Diagnostics.Trace.WriteLine("message: " & message)
    System.Diagnostics.Trace.WriteLine("member name: " & memberName)
    System.Diagnostics.Trace.WriteLine("source file path: " & sourcefilePath)
    System.Diagnostics.Trace.WriteLine("source line number: " & sourceLineNumber)
End Sub

' Sample output:
'   message: Something happened.
'   member name: DoProcessing
'   source file path: C:\Users\username\Documents\Visual Studio 2012\Projects\CallerInfoVB\CallerInfoVB\Form1.vb
'   source line number: 15

Remarques

Vous appliquez l’attribut CallerMemberName à un paramètre facultatif qui a une valeur par défaut. Vous devez spécifier une valeur par défaut explicite pour le paramètre facultatif. Vous ne pouvez pas appliquer cet attribut aux paramètres qui ne sont pas spécifiés comme facultatifs.

Pour plus d’informations, consultez Informations sur l’appelant.

Vous pouvez utiliser l'attribut CallerMemberName pour éviter de spécifier le nom du membre comme argument de String à la méthode appelée. Vous évitez ainsi le problème que la refactorisation de changement de nom ne modifie pas les valeurs String. Cela est particulièrement utile pour les tâches suivantes :

• Utilisation du traçage et des programmes de diagnostic.

• Implémentation de l'interface INotifyPropertyChanged lors de la liaison de données. Cette interface permet à la propriété d'un objet de signaler à un contrôle dépendant que la propriété a été modifiée, afin que ce contrôle puisse afficher les informations mises à jour. Sans attribut CallerMemberName, vous devez spécifier le nom de la propriété comme littéral.

Le graphique suivant affiche les noms des membres qui sont retournés lorsque vous utilisez l'attribut CallerMemberName.

L’appel se produit dans	Résultat de nom de membre
Méthode, propriété ou événement	Le nom de la méthode, la propriété ou l'événement dont l'appel est originaire.
Constructeur	La chaîne « .ctor »
Constructeur statique	La chaîne « .cctor »
Destructeur	La chaîne « finalize »
Opérateurs définis par l'utilisateur ou conversions	Le nom généré pour le membre, par exemple, « op_Addition ».
Constructeur d'attribut	Le nom du membre auquel l'attribut est appliqué. Si l'attribut est un élément dans un membre (tel qu'un paramètre, une valeur de retour, ou un paramètre de type générique), le résultat est le nom du membre qui est associé à cet élément.
Aucun membre contenant (par exemple, au niveau de l’assembly ou des attributs appliqués aux types)	Valeur par défaut du paramètre optionnel.

Constructeurs

CallerMemberNameAttribute()

Initialise une nouvelle instance de la classe CallerMemberNameAttribute.

Propriétés

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)	Retourne une valeur qui indique si cette instance est égale à un objet spécifié. (Hérité de Attribute)
GetHashCode()	Retourne le code de hachage de cette instance. (Hérité de Attribute)
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
IsDefaultAttribute()	En cas de substitution dans une classe dérivée, indique si la valeur de cette instance est la valeur par défaut pour la classe dérivée. (Hérité de Attribute)
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)

Voir aussi

• CallerFilePathAttribute
• CallerLineNumberAttribute
• Informations relatives à l'appelant (C# et Visual Basic)