CallerMemberNameAttribute Classe

Definição

Namespace:

System.Runtime.CompilerServices

Assemblies:

netstandard.dll, System.Runtime.dll

Origem:

CallerMemberNameAttribute.cs

Parâmetro de marcas que deve ser preenchido com o nome do membro do chamador 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

Herança

Object

Attribute

CallerMemberNameAttribute

Atributos

AttributeUsageAttribute

Exemplos

O exemplo a seguir mostra como usar o CallerMemberName atributo. Em cada chamada para o TraceMessage método, as informações do chamador são substituídas como um argumento para o 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

Comentários

Você aplica o CallerMemberName atributo a um parâmetro opcional que tem um valor padrão. Você deve especificar um valor padrão explícito para o parâmetro opcional. Você não pode aplicar esse atributo a parâmetros que não são especificados como opcionais.

Você pode usar o CallerMemberName atributo para evitar especificar o nome do membro como um String argumento para o método chamado. Ao usar essa técnica, você evita o problema de que a Refatoração de Renomeação não altera os valores de String. Isso é especialmente útil para as seguintes tarefas:

• Usar rotinas de rastreamento e diagnóstico.

• Implementando a INotifyPropertyChanged interface ao associar dados. Essa interface permite que a propriedade de um objeto notifique um controle associado de que a propriedade foi alterada, para que o controle possa exibir as informações atualizadas. Sem o atributo CallerMemberName, você deve especificar o nome da propriedade como um valor literal.

O gráfico a seguir mostra os nomes de membro que são retornados quando você usa o CallerMemberName atributo.

A chamada ocorre dentro	Resultado de nome de membro
Método, propriedade ou evento	O nome do método, propriedade ou evento do qual a chamada se originou.
Construtor	A cadeia de caracteres “.ctor”
Construtor estático	A cadeia de caracteres “.cctor”
Destruidor	A cadeia de caracteres "Finalize"
Operadores ou conversões definidos pelo usuário	O nome gerado para o membro, por exemplo, "op_Addition".
Construtor de atributos	O nome do membro ao qual o atributo é aplicado. Se o atributo for qualquer elemento dentro de um membro (como um parâmetro, um valor retornado ou um parâmetro de tipo genérico), esse resultado será o nome do membro associado a esse elemento.
Nenhum membro independente (por exemplo, nível de assembly ou atributos aplicados a tipos)	O valor padrão do parâmetro opcional.

Construtores

Nome	Description
CallerMemberNameAttribute()	Inicializa uma nova instância da classe CallerMemberNameAttribute.

Propriedades

Nome	Description
TypeId	Quando implementado em uma classe derivada, obtém um identificador exclusivo para esse Attribute. (Herdado de Attribute)

Métodos

Nome	Description
Equals(Object)	Retorna um valor que indica se essa instância é igual a um objeto especificado. (Herdado de Attribute)
GetHashCode()	Retorna o código hash dessa instância. (Herdado de Attribute)
GetType()	Obtém o Type da instância atual. (Herdado de Object)
IsDefaultAttribute()	Quando substituído em uma classe derivada, indica se o valor dessa instância é o valor padrão para a classe derivada. (Herdado de Attribute)
Match(Object)	Quando substituído em uma classe derivada, retorna um valor que indica se essa instância é igual a um objeto especificado. (Herdado de Attribute)
MemberwiseClone()	Cria uma cópia superficial do Objectatual. (Herdado de Object)
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object)

Confira também

• CallerFilePathAttribute
• CallerLineNumberAttribute