CallerMemberNameAttribute Clase

Definición

Espacio de nombres:

System.Runtime.CompilerServices

Ensamblados:

netstandard.dll, System.Runtime.dll

Source:

CallerMemberNameAttribute.cs

Parámetro de etiquetas que se debe rellenar con un nombre de miembro de llamada específico.

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

Herencia

Object

Attribute

CallerMemberNameAttribute

Atributos

AttributeUsageAttribute

Ejemplos

En el ejemplo siguiente se muestra cómo usar el CallerMemberName atributo . En cada llamada al TraceMessage método , la información del autor de la llamada se sustituye como argumento para el parámetro opcional.

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

Comentarios

El atributo se aplica CallerMemberName a un parámetro opcional que tiene un valor predeterminado. Debe especificar un valor predeterminado explícito para el parámetro opcional. No se puede aplicar este atributo a los parámetros que no se especifican como opcionales.

Puede usar el CallerMemberName atributo para evitar especificar el nombre de miembro como argumento String para el método llamado. Mediante esta técnica, se evita el problema de que la refactorización de cambio de nombre no cambie los valores String. Esto resulta especialmente útil para las siguientes tareas:

• Uso de rutinas de seguimiento y diagnóstico.

• Implementación de la INotifyPropertyChanged interfaz al enlazar datos. Esta interfaz permite que la propiedad de un objeto notifique a un control enlazado que la propiedad ha cambiado, de modo que el control pueda mostrar la información actualizada. Sin el atributo CallerMemberName, se debe especificar el nombre de propiedad como un literal.

En el gráfico siguiente se muestran los nombres de miembro que se devuelven al usar el CallerMemberName atributo .

Se produce una llamada dentro de	Resultado del nombre de miembro
Método, propiedad o evento	Nombre del método, propiedad o evento desde el que se originó la llamada.
Constructor	Cadena ".ctor"
Constructor estático	Cadena ".cctor"
Destructor	Cadena "Finalize"
Operadores o conversiones definidos por el usuario	Nombre generado para el miembro, por ejemplo, "op_Addition".
Constructor de atributos	Nombre del miembro al que se aplica el atributo. Si el atributo es cualquier elemento dentro de un miembro (como un parámetro, un valor devuelto o un parámetro de tipo genérico), este resultado es el nombre del miembro asociado a ese elemento.
No contiene miembros (por ejemplo, de nivel de ensamblado o atributos aplicados a tipos)	Valor predeterminado del parámetro opcional.

Constructores

Nombre	Description
CallerMemberNameAttribute()	Inicializa una nueva instancia de la clase CallerMemberNameAttribute.

Propiedades

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

Métodos

Nombre	Description
Equals(Object)	Devuelve un valor que indica si esta instancia es igual a un objeto especificado. (Heredado de Attribute)
GetHashCode()	Devuelve el código hash de esta instancia. (Heredado de Attribute)
GetType()	Obtiene el Type de la instancia actual. (Heredado de Object)
IsDefaultAttribute()	Cuando se reemplaza en una clase derivada, indica si el valor de esta instancia es el valor predeterminado de la clase derivada. (Heredado de Attribute)
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)

Consulte también

• CallerFilePathAttribute
• CallerLineNumberAttribute