CallerMemberNameAttribute Classe

Definizione

Spazio dei nomi:

System.Runtime.CompilerServices

Assembly:

System.Runtime.dll

Source:

CallerMemberNameAttribute.cs

Consente di ottenere il nome del metodo o della proprietà del chiamante per il metodo.

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

Ereditarietà

Object

Attribute

CallerMemberNameAttribute

Attributi

AttributeUsageAttribute

Esempio

Nell'esempio seguente viene illustrato l'utilizzo dell'attributo CallerMemberName. In ogni chiamata al TraceMessage metodo, le informazioni del chiamante vengono sostituite come argomento al parametro facoltativo.

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

Commenti

Si applica l'attributo CallerMemberName a un parametro facoltativo con un valore predefinito. È necessario specificare un valore predefinito esplicito per il parametro facoltativo. Non è possibile applicare questo attributo ai parametri non specificati come facoltativi.

Per altre informazioni, vedere Informazioni sul chiamante.

È possibile utilizzare l'attributo CallerMemberName per specificare il nome del membro come argomento String al metodo chiamato. Usando questa tecnica, si evita il problema per cui il refactoring di ridenominazione non modifica i valori String. Questo è particolarmente utile per le attività seguenti:

• Utilizzo della tracciatura e delle routine di diagnostica.

• Implementazione dell'interfaccia INotifyPropertyChanged durante l'associazione dei dati. Questa interfaccia consente alla proprietà di un oggetto di notificare a un controllo associato la modifica della proprietà stessa in modo che il controllo possa visualizzare le informazioni aggiornate. Senza l'attributo CallerMemberName, è necessario specificare il nome della proprietà come valore letterale.

Nel grafico seguente vengono mostrati i nomi dei membri restituiti quando si utilizza l'attributo CallerMemberName.

La chiamata si verifica all'interno	Nome del membro restituito
Metodo, proprietà o evento	Nome del metodo, della proprietà o dell'evento da cui la chiamata ha avuto origine.
Costruttore	Stringa ".ctor"
Costruttore statico	Stringa ".cctor"
Distruttore	Stringa "Finalize"
Operatori o conversioni definiti dall'utente	Nome generato per il membro, ad esempio "op_Addition".
Costruttore dell'attributo	Nome del membro a cui viene applicato l'attributo. Se l'attributo è un qualsiasi elemento in un membro (ad esempio un parametro, un valore restituito o un parametro di tipo generico), il risultato è il nome del membro associato a tale elemento.
Nessun membro contenente (ad esempio, a livello di assembly o attributi applicati ai tipi)	Valore predefinito del parametro facoltativo.

Costruttori

CallerMemberNameAttribute()

Inizializza una nuova istanza della classe CallerMemberNameAttribute.

Proprietà

TypeId

Quando è implementata in una classe derivata, ottiene un identificatore univoco della classe Attribute. (Ereditato da Attribute)

Metodi

Equals(Object)	Restituisce un valore che indica se questa istanza è uguale a un oggetto specificato. (Ereditato da Attribute)
GetHashCode()	Restituisce il codice hash per l'istanza. (Ereditato da Attribute)
GetType()	Ottiene l'oggetto Type dell'istanza corrente. (Ereditato da Object)
IsDefaultAttribute()	In caso di override in una classe derivata, indica se il valore di questa istanza è il valore predefinito per la classe derivata. (Ereditato da Attribute)
Match(Object)	Quando è sottoposto a override in una classe derivata, restituisce un valore che indica se questa istanza equivale a un oggetto specificato. (Ereditato da Attribute)
MemberwiseClone()	Crea una copia superficiale dell'oggetto Object corrente. (Ereditato da Object)
ToString()	Restituisce una stringa che rappresenta l'oggetto corrente. (Ereditato da Object)

Vedi anche

• CallerFilePathAttribute
• CallerLineNumberAttribute
• Informazioni sul chiamante (C# e Visual Basic)