CallerMemberNameAttribute Třída

Definice

Obor názvů:

System.Runtime.CompilerServices

Sestavení:

System.Runtime.dll

Source:

CallerMemberNameAttribute.cs

Umožňuje získat název metody nebo vlastnosti volajícího metody.

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

Dědičnost

Object

Attribute

CallerMemberNameAttribute

Atributy

AttributeUsageAttribute

Příklady

Následující příklad ukazuje použití atributu CallerMemberName . Při každém volání TraceMessage metody jsou informace o volajícím nahrazeny jako argument volitelného parametru.

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

Poznámky

Atribut použijete CallerMemberName na volitelný parametr, který má výchozí hodnotu. Musíte zadat explicitní výchozí hodnotu volitelného parametru. Tento atribut nemůžete použít u parametrů, které nejsou zadané jako volitelné.

Další informace najdete v tématu Informace o volajícím.

Pomocí atributu CallerMemberName se můžete vyhnout zadání názvu člena jako String argumentu pro volanou metodu. Pomocí této techniky se vyhnete problému, který znamená, že refaktoring přejmenování nezmění String hodnoty. To je zvlášť užitečné pro následující úlohy:

• Použití trasování a diagnostických rutin.

• INotifyPropertyChanged Implementace rozhraní při vytváření vazby dat. Toto rozhraní umožňuje vlastnosti objektu oznámit vázanému ovládacímu prvku, že došlo ke změně vlastnosti, aby ovládací prvek mohl zobrazit aktualizované informace. Bez atributu CallerMemberName musíte zadat název vlastnosti jako literál.

Následující graf zobrazuje názvy členů, které se vrátí při použití atributu CallerMemberName .

Volání probíhá v rámci	Výsledek názvu členu
Metoda, vlastnost nebo událost	Název metody, vlastnosti nebo události, z nichž bylo volání provedeno.
Konstruktor	Řetězec „.ctor“
Statický konstruktor	Řetězec „.cctor“
Destruktor	Řetězec „Finalize“
Operátory nebo převody definované uživatelem	Vygenerovaný název pro člen, například „op_Addition“.
Konstruktor atributu	Název členu, na který se atribut používá. Pokud je atribut libovolný prvek v členu (například parametr, návratová hodnota nebo parametr obecného typu), je tento výsledek názvem členu, který je přidružen k tomuto prvku.
Žádný obsahující člen (například na úrovni sestavení nebo atributy použité u typů)	Výchozí hodnota volitelného parametru.

Konstruktory

CallerMemberNameAttribute()

Inicializuje novou instanci CallerMemberNameAttribute třídy .

Vlastnosti

TypeId

Při implementaci v odvozené třídě získá jedinečný identifikátor pro tuto Attributetřídu . (Zděděno od Attribute)

Metody

Equals(Object)	Vrací hodnotu, která určuje, zda je tato instance rovna zadanému objektu. (Zděděno od Attribute)
GetHashCode()	Vrátí hodnotu hash pro tuto instanci. (Zděděno od Attribute)
GetType()	Type Získá z aktuální instance. (Zděděno od Object)
IsDefaultAttribute()	Při přepsání v odvozené třídě označuje, zda je hodnota této instance výchozí hodnotou pro odvozenou třídu. (Zděděno od Attribute)
Match(Object)	Při přepsání v odvozené třídě vrátí hodnotu, která označuje, zda se tato instance rovná zadanému objektu. (Zděděno od Attribute)
MemberwiseClone()	Vytvoří mělkou kopii aktuálního Objectsouboru . (Zděděno od Object)
ToString()	Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object)

Viz také

• CallerFilePathAttribute
• CallerLineNumberAttribute
• Informace o volajícím (C# and Visual Basic)